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 java.util.List;
045import javax.enterprise.context.Dependent;
046import javax.inject.Inject;
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    @Inject
080    CarrierControl carrierControl;
081
082    @Inject
083    SelectorControl selectorControl;
084
085    
086    /** Creates a new instance of EditCarrierServiceCommand */
087    public EditCarrierServiceCommand() {
088        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
089    }
090    
091    @Override
092    public EditCarrierServiceResult getResult() {
093        return CarrierResultFactory.getEditCarrierServiceResult();
094    }
095
096    @Override
097    public CarrierServiceEdit getEdit() {
098        return CarrierEditFactory.getCarrierServiceEdit();
099    }
100
101    Party carrierParty;
102
103    @Override
104    public CarrierService getEntity(EditCarrierServiceResult result) {
105        CarrierService carrierService = null;
106        var carrierName = spec.getCarrierName();
107        var carrier = carrierControl.getCarrierByName(carrierName);
108
109        if(carrier != null) {
110            var carrierServiceName = spec.getCarrierServiceName();
111            
112            carrierParty = carrier.getParty();
113
114            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
115                carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
116            } else { // EditMode.UPDATE
117                carrierService = carrierControl.getCarrierServiceByNameForUpdate(carrierParty, carrierServiceName);
118            }
119
120            if(carrierService != null) {
121                result.setCarrierService(carrierControl.getCarrierServiceTransfer(getUserVisit(), carrierService));
122            } else {
123                addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierName, carrierServiceName);
124            }
125        } else {
126            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
127        }
128
129        return carrierService;
130    }
131
132    @Override
133    public CarrierService getLockEntity(CarrierService carrierService) {
134        return carrierService;
135    }
136
137    @Override
138    public void fillInResult(EditCarrierServiceResult result, CarrierService carrierService) {
139        result.setCarrierService(carrierControl.getCarrierServiceTransfer(getUserVisit(), carrierService));
140    }
141
142    Selector geoCodeSelector;
143    Selector itemSelector;
144
145    @Override
146    public void doLock(CarrierServiceEdit edit, CarrierService carrierService) {
147        var carrierServiceDescription = carrierControl.getCarrierServiceDescription(carrierService, getPreferredLanguage());
148        var carrierServiceDetail = carrierService.getLastDetail();
149
150        geoCodeSelector = carrierServiceDetail.getGeoCodeSelector();
151        itemSelector = carrierServiceDetail.getItemSelector();
152
153        edit.setCarrierServiceName(carrierServiceDetail.getCarrierServiceName());
154        edit.setGeoCodeSelectorName(itemSelector == null ? null: geoCodeSelector.getLastDetail().getSelectorName());
155        edit.setItemSelectorName(itemSelector == null ? null: itemSelector.getLastDetail().getSelectorName());
156        edit.setIsDefault(carrierServiceDetail.getIsDefault().toString());
157        edit.setSortOrder(carrierServiceDetail.getSortOrder().toString());
158
159        if(carrierServiceDescription != null) {
160            edit.setDescription(carrierServiceDescription.getDescription());
161        }
162    }
163
164    @Override
165    public void canUpdate(CarrierService carrierService) {
166        var carrierServiceName = edit.getCarrierServiceName();
167        var duplicateCarrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
168
169        if(duplicateCarrierService == null || carrierService.equals(duplicateCarrierService)) {
170            var geoCodeSelectorName = edit.getGeoCodeSelectorName();
171
172            if(geoCodeSelectorName != null) {
173                var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.POSTAL_ADDRESS.name());
174
175                if(selectorKind != null) {
176                    var selectorType = selectorControl.getSelectorTypeByName(selectorKind,
177                            SelectorTypes.CARRIER.name());
178
179                    if(selectorType != null) {
180                        geoCodeSelector = selectorControl.getSelectorByName(selectorType, geoCodeSelectorName);
181                    } else {
182                        addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.POSTAL_ADDRESS.name(),
183                                SelectorTypes.CARRIER_SERVICE.name());
184                    }
185                } else {
186                    addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.POSTAL_ADDRESS.name());
187                }
188            }
189
190            if(geoCodeSelectorName == null || geoCodeSelector != null) {
191                var itemSelectorName = edit.getItemSelectorName();
192
193                if(itemSelectorName != null) {
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 partyPK = getPartyPK();
225        var carrierServiceDetailValue = carrierControl.getCarrierServiceDetailValueForUpdate(carrierService);
226        var carrierServiceDescription = carrierControl.getCarrierServiceDescriptionForUpdate(carrierService, getPreferredLanguage());
227        var description = edit.getDescription();
228
229        carrierServiceDetailValue.setCarrierServiceName(edit.getCarrierServiceName());
230        carrierServiceDetailValue.setGeoCodeSelectorPK(geoCodeSelector == null ? null : geoCodeSelector.getPrimaryKey());
231        carrierServiceDetailValue.setItemSelectorPK(itemSelector == null ? null : itemSelector.getPrimaryKey());
232        carrierServiceDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
233        carrierServiceDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
234
235        carrierControl.updateCarrierServiceFromValue(carrierServiceDetailValue, partyPK);
236
237        if(carrierServiceDescription == null && description != null) {
238            carrierControl.createCarrierServiceDescription(carrierService, getPreferredLanguage(), description, partyPK);
239        } else {
240            if(carrierServiceDescription != null && description == null) {
241                carrierControl.deleteCarrierServiceDescription(carrierServiceDescription, partyPK);
242            } else {
243                if(carrierServiceDescription != null && description != null) {
244                    var carrierServiceDescriptionValue = carrierControl.getCarrierServiceDescriptionValue(carrierServiceDescription);
245
246                    carrierServiceDescriptionValue.setDescription(description);
247                    carrierControl.updateCarrierServiceDescriptionFromValue(carrierServiceDescriptionValue, partyPK);
248                }
249            }
250        }
251    }
252    
253}