001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.carrier.server.command;
018
019import com.echothree.control.user.carrier.common.edit.CarrierEditFactory;
020import com.echothree.control.user.carrier.common.edit.CarrierServiceEdit;
021import com.echothree.control.user.carrier.common.form.EditCarrierServiceForm;
022import com.echothree.control.user.carrier.common.result.CarrierResultFactory;
023import com.echothree.control.user.carrier.common.result.EditCarrierServiceResult;
024import com.echothree.control.user.carrier.common.spec.CarrierServiceSpec;
025import com.echothree.model.control.carrier.server.control.CarrierControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.control.selector.common.SelectorKinds;
030import com.echothree.model.control.selector.common.SelectorTypes;
031import com.echothree.model.control.selector.server.control.SelectorControl;
032import com.echothree.model.data.carrier.server.entity.CarrierService;
033import com.echothree.model.data.party.server.entity.Party;
034import com.echothree.model.data.selector.server.entity.Selector;
035import com.echothree.model.data.user.common.pk.UserVisitPK;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.server.control.BaseAbstractEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.List;
046import javax.enterprise.context.Dependent;
047
048@Dependent
049public class EditCarrierServiceCommand
050        extends BaseAbstractEditCommand<CarrierServiceSpec, CarrierServiceEdit, EditCarrierServiceResult, CarrierService, CarrierService> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
060                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierService.name(), SecurityRoles.Edit.name())
061                        ))
062                ));
063
064        SPEC_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, true, null, null)
067                );
068        
069        EDIT_FIELD_DEFINITIONS = List.of(
070                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, true, null, null),
071                new FieldDefinition("GeoCodeSelectorName", FieldType.ENTITY_NAME, false, null, null),
072                new FieldDefinition("ItemSelectorName", FieldType.ENTITY_NAME, true, null, null),
073                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
074                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
075                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
076                );
077    }
078    
079    /** Creates a new instance of EditCarrierServiceCommand */
080    public EditCarrierServiceCommand() {
081        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083    
084    @Override
085    public EditCarrierServiceResult getResult() {
086        return CarrierResultFactory.getEditCarrierServiceResult();
087    }
088
089    @Override
090    public CarrierServiceEdit getEdit() {
091        return CarrierEditFactory.getCarrierServiceEdit();
092    }
093
094    Party carrierParty;
095
096    @Override
097    public CarrierService getEntity(EditCarrierServiceResult result) {
098        var carrierControl = Session.getModelController(CarrierControl.class);
099        CarrierService carrierService = null;
100        var carrierName = spec.getCarrierName();
101        var carrier = carrierControl.getCarrierByName(carrierName);
102
103        if(carrier != null) {
104            var carrierServiceName = spec.getCarrierServiceName();
105            
106            carrierParty = carrier.getParty();
107
108            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
109                carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
110            } else { // EditMode.UPDATE
111                carrierService = carrierControl.getCarrierServiceByNameForUpdate(carrierParty, carrierServiceName);
112            }
113
114            if(carrierService != null) {
115                result.setCarrierService(carrierControl.getCarrierServiceTransfer(getUserVisit(), carrierService));
116            } else {
117                addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierName, carrierServiceName);
118            }
119        } else {
120            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
121        }
122
123        return carrierService;
124    }
125
126    @Override
127    public CarrierService getLockEntity(CarrierService carrierService) {
128        return carrierService;
129    }
130
131    @Override
132    public void fillInResult(EditCarrierServiceResult result, CarrierService carrierService) {
133        var carrierControl = Session.getModelController(CarrierControl.class);
134
135        result.setCarrierService(carrierControl.getCarrierServiceTransfer(getUserVisit(), carrierService));
136    }
137
138    Selector geoCodeSelector;
139    Selector itemSelector;
140
141    @Override
142    public void doLock(CarrierServiceEdit edit, CarrierService carrierService) {
143        var carrierControl = Session.getModelController(CarrierControl.class);
144        var carrierServiceDescription = carrierControl.getCarrierServiceDescription(carrierService, getPreferredLanguage());
145        var carrierServiceDetail = carrierService.getLastDetail();
146
147        geoCodeSelector = carrierServiceDetail.getGeoCodeSelector();
148        itemSelector = carrierServiceDetail.getItemSelector();
149
150        edit.setCarrierServiceName(carrierServiceDetail.getCarrierServiceName());
151        edit.setGeoCodeSelectorName(itemSelector == null ? null: geoCodeSelector.getLastDetail().getSelectorName());
152        edit.setItemSelectorName(itemSelector == null ? null: itemSelector.getLastDetail().getSelectorName());
153        edit.setIsDefault(carrierServiceDetail.getIsDefault().toString());
154        edit.setSortOrder(carrierServiceDetail.getSortOrder().toString());
155
156        if(carrierServiceDescription != null) {
157            edit.setDescription(carrierServiceDescription.getDescription());
158        }
159    }
160
161    @Override
162    public void canUpdate(CarrierService carrierService) {
163        var carrierControl = Session.getModelController(CarrierControl.class);
164        var carrierServiceName = edit.getCarrierServiceName();
165        var duplicateCarrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
166
167        if(duplicateCarrierService == null || carrierService.equals(duplicateCarrierService)) {
168            var geoCodeSelectorName = edit.getGeoCodeSelectorName();
169
170            if(geoCodeSelectorName != null) {
171                var selectorControl = Session.getModelController(SelectorControl.class);
172                var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.POSTAL_ADDRESS.name());
173
174                if(selectorKind != null) {
175                    var selectorType = selectorControl.getSelectorTypeByName(selectorKind,
176                            SelectorTypes.CARRIER.name());
177
178                    if(selectorType != null) {
179                        geoCodeSelector = selectorControl.getSelectorByName(selectorType, geoCodeSelectorName);
180                    } else {
181                        addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.POSTAL_ADDRESS.name(),
182                                SelectorTypes.CARRIER_SERVICE.name());
183                    }
184                } else {
185                    addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.POSTAL_ADDRESS.name());
186                }
187            }
188
189            if(geoCodeSelectorName == null || geoCodeSelector != null) {
190                var itemSelectorName = edit.getItemSelectorName();
191
192                if(itemSelectorName != null) {
193                    var selectorControl = Session.getModelController(SelectorControl.class);
194                    var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ITEM.name());
195
196                    if(selectorKind != null) {
197                        var selectorType = selectorControl.getSelectorTypeByName(selectorKind,
198                                SelectorTypes.CARRIER.name());
199
200                        if(selectorType != null) {
201                            itemSelector = selectorControl.getSelectorByName(selectorType, itemSelectorName);
202                        } else {
203                            addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.ITEM.name(),
204                                    SelectorTypes.CARRIER_SERVICE.name());
205                        }
206                    } else {
207                        addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ITEM.name());
208                    }
209                }
210
211                if(itemSelectorName != null && itemSelector == null) {
212                    addExecutionError(ExecutionErrors.UnknownItemSelectorName.name(), itemSelectorName);
213                }
214            } else {
215                addExecutionError(ExecutionErrors.UnknownGeoCodeSelectorName.name(), geoCodeSelectorName);
216            }
217        } else {
218            addExecutionError(ExecutionErrors.DuplicateCarrierServiceName.name(), carrierServiceName);
219        }
220    }
221
222    @Override
223    public void doUpdate(CarrierService carrierService) {
224        var carrierControl = Session.getModelController(CarrierControl.class);
225        var partyPK = getPartyPK();
226        var carrierServiceDetailValue = carrierControl.getCarrierServiceDetailValueForUpdate(carrierService);
227        var carrierServiceDescription = carrierControl.getCarrierServiceDescriptionForUpdate(carrierService, getPreferredLanguage());
228        var description = edit.getDescription();
229
230        carrierServiceDetailValue.setCarrierServiceName(edit.getCarrierServiceName());
231        carrierServiceDetailValue.setGeoCodeSelectorPK(geoCodeSelector == null ? null : geoCodeSelector.getPrimaryKey());
232        carrierServiceDetailValue.setItemSelectorPK(itemSelector == null ? null : itemSelector.getPrimaryKey());
233        carrierServiceDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
234        carrierServiceDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
235
236        carrierControl.updateCarrierServiceFromValue(carrierServiceDetailValue, partyPK);
237
238        if(carrierServiceDescription == null && description != null) {
239            carrierControl.createCarrierServiceDescription(carrierService, getPreferredLanguage(), description, partyPK);
240        } else {
241            if(carrierServiceDescription != null && description == null) {
242                carrierControl.deleteCarrierServiceDescription(carrierServiceDescription, partyPK);
243            } else {
244                if(carrierServiceDescription != null && description != null) {
245                    var carrierServiceDescriptionValue = carrierControl.getCarrierServiceDescriptionValue(carrierServiceDescription);
246
247                    carrierServiceDescriptionValue.setDescription(description);
248                    carrierControl.updateCarrierServiceDescriptionFromValue(carrierServiceDescriptionValue, partyPK);
249                }
250            }
251        }
252    }
253    
254}