001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.Arrays;
046import java.util.Collections;
047import java.util.List;
048import javax.enterprise.context.RequestScoped;
049
050@RequestScoped
051public class EditCarrierServiceCommand
052        extends BaseAbstractEditCommand<CarrierServiceSpec, CarrierServiceEdit, EditCarrierServiceResult, CarrierService, CarrierService> {
053    
054    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
055    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
056    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
057    
058    static {
059        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
060                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
061                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
062                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierService.name(), SecurityRoles.Edit.name())
063                        )))
064                )));
065
066        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
067                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, true, null, null)
069                ));
070        
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, true, null, null),
073                new FieldDefinition("GeoCodeSelectorName", FieldType.ENTITY_NAME, false, null, null),
074                new FieldDefinition("ItemSelectorName", FieldType.ENTITY_NAME, true, null, null),
075                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
076                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
077                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
078                ));
079    }
080    
081    /** Creates a new instance of EditCarrierServiceCommand */
082    public EditCarrierServiceCommand() {
083        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
084    }
085    
086    @Override
087    public EditCarrierServiceResult getResult() {
088        return CarrierResultFactory.getEditCarrierServiceResult();
089    }
090
091    @Override
092    public CarrierServiceEdit getEdit() {
093        return CarrierEditFactory.getCarrierServiceEdit();
094    }
095
096    Party carrierParty;
097
098    @Override
099    public CarrierService getEntity(EditCarrierServiceResult result) {
100        var carrierControl = Session.getModelController(CarrierControl.class);
101        CarrierService carrierService = null;
102        var carrierName = spec.getCarrierName();
103        var carrier = carrierControl.getCarrierByName(carrierName);
104
105        if(carrier != null) {
106            var carrierServiceName = spec.getCarrierServiceName();
107            
108            carrierParty = carrier.getParty();
109
110            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
111                carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
112            } else { // EditMode.UPDATE
113                carrierService = carrierControl.getCarrierServiceByNameForUpdate(carrierParty, carrierServiceName);
114            }
115
116            if(carrierService != null) {
117                result.setCarrierService(carrierControl.getCarrierServiceTransfer(getUserVisit(), carrierService));
118            } else {
119                addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierName, carrierServiceName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
123        }
124
125        return carrierService;
126    }
127
128    @Override
129    public CarrierService getLockEntity(CarrierService carrierService) {
130        return carrierService;
131    }
132
133    @Override
134    public void fillInResult(EditCarrierServiceResult result, CarrierService carrierService) {
135        var carrierControl = Session.getModelController(CarrierControl.class);
136
137        result.setCarrierService(carrierControl.getCarrierServiceTransfer(getUserVisit(), carrierService));
138    }
139
140    Selector geoCodeSelector;
141    Selector itemSelector;
142
143    @Override
144    public void doLock(CarrierServiceEdit edit, CarrierService carrierService) {
145        var carrierControl = Session.getModelController(CarrierControl.class);
146        var carrierServiceDescription = carrierControl.getCarrierServiceDescription(carrierService, getPreferredLanguage());
147        var carrierServiceDetail = carrierService.getLastDetail();
148
149        geoCodeSelector = carrierServiceDetail.getGeoCodeSelector();
150        itemSelector = carrierServiceDetail.getItemSelector();
151
152        edit.setCarrierServiceName(carrierServiceDetail.getCarrierServiceName());
153        edit.setGeoCodeSelectorName(itemSelector == null ? null: geoCodeSelector.getLastDetail().getSelectorName());
154        edit.setItemSelectorName(itemSelector == null ? null: itemSelector.getLastDetail().getSelectorName());
155        edit.setIsDefault(carrierServiceDetail.getIsDefault().toString());
156        edit.setSortOrder(carrierServiceDetail.getSortOrder().toString());
157
158        if(carrierServiceDescription != null) {
159            edit.setDescription(carrierServiceDescription.getDescription());
160        }
161    }
162
163    @Override
164    public void canUpdate(CarrierService carrierService) {
165        var carrierControl = Session.getModelController(CarrierControl.class);
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 selectorControl = Session.getModelController(SelectorControl.class);
174                var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.POSTAL_ADDRESS.name());
175
176                if(selectorKind != null) {
177                    var selectorType = selectorControl.getSelectorTypeByName(selectorKind,
178                            SelectorTypes.CARRIER.name());
179
180                    if(selectorType != null) {
181                        geoCodeSelector = selectorControl.getSelectorByName(selectorType, geoCodeSelectorName);
182                    } else {
183                        addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.POSTAL_ADDRESS.name(),
184                                SelectorTypes.CARRIER_SERVICE.name());
185                    }
186                } else {
187                    addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.POSTAL_ADDRESS.name());
188                }
189            }
190
191            if(geoCodeSelectorName == null || geoCodeSelector != null) {
192                var itemSelectorName = edit.getItemSelectorName();
193
194                if(itemSelectorName != null) {
195                    var selectorControl = Session.getModelController(SelectorControl.class);
196                    var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ITEM.name());
197
198                    if(selectorKind != null) {
199                        var selectorType = selectorControl.getSelectorTypeByName(selectorKind,
200                                SelectorTypes.CARRIER.name());
201
202                        if(selectorType != null) {
203                            itemSelector = selectorControl.getSelectorByName(selectorType, itemSelectorName);
204                        } else {
205                            addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.ITEM.name(),
206                                    SelectorTypes.CARRIER_SERVICE.name());
207                        }
208                    } else {
209                        addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ITEM.name());
210                    }
211                }
212
213                if(itemSelectorName != null && itemSelector == null) {
214                    addExecutionError(ExecutionErrors.UnknownItemSelectorName.name(), itemSelectorName);
215                }
216            } else {
217                addExecutionError(ExecutionErrors.UnknownGeoCodeSelectorName.name(), geoCodeSelectorName);
218            }
219        } else {
220            addExecutionError(ExecutionErrors.DuplicateCarrierServiceName.name(), carrierServiceName);
221        }
222    }
223
224    @Override
225    public void doUpdate(CarrierService carrierService) {
226        var carrierControl = Session.getModelController(CarrierControl.class);
227        var partyPK = getPartyPK();
228        var carrierServiceDetailValue = carrierControl.getCarrierServiceDetailValueForUpdate(carrierService);
229        var carrierServiceDescription = carrierControl.getCarrierServiceDescriptionForUpdate(carrierService, getPreferredLanguage());
230        var description = edit.getDescription();
231
232        carrierServiceDetailValue.setCarrierServiceName(edit.getCarrierServiceName());
233        carrierServiceDetailValue.setGeoCodeSelectorPK(geoCodeSelector == null ? null : geoCodeSelector.getPrimaryKey());
234        carrierServiceDetailValue.setItemSelectorPK(itemSelector == null ? null : itemSelector.getPrimaryKey());
235        carrierServiceDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
236        carrierServiceDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
237
238        carrierControl.updateCarrierServiceFromValue(carrierServiceDetailValue, partyPK);
239
240        if(carrierServiceDescription == null && description != null) {
241            carrierControl.createCarrierServiceDescription(carrierService, getPreferredLanguage(), description, partyPK);
242        } else {
243            if(carrierServiceDescription != null && description == null) {
244                carrierControl.deleteCarrierServiceDescription(carrierServiceDescription, partyPK);
245            } else {
246                if(carrierServiceDescription != null && description != null) {
247                    var carrierServiceDescriptionValue = carrierControl.getCarrierServiceDescriptionValue(carrierServiceDescription);
248
249                    carrierServiceDescriptionValue.setDescription(description);
250                    carrierControl.updateCarrierServiceDescriptionFromValue(carrierServiceDescriptionValue, partyPK);
251                }
252            }
253        }
254    }
255    
256}