Source code

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.form.CreateCarrierOptionForm;
020import com.echothree.control.user.carrier.common.result.CarrierResultFactory;
021import com.echothree.model.control.carrier.server.control.CarrierControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.selector.common.SelectorKinds;
026import com.echothree.model.control.selector.common.SelectorTypes;
027import com.echothree.model.control.selector.server.control.SelectorControl;
028import com.echothree.model.data.carrier.server.entity.CarrierOption;
029import com.echothree.model.data.selector.server.entity.Selector;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class CreateCarrierOptionCommand
045        extends BaseSimpleCommand<CreateCarrierOptionForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
054                        new SecurityRoleDefinition(SecurityRoleGroups.CarrierOption.name(), SecurityRoles.Create.name())
055                ))
056        ));
057
058        FORM_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("CarrierOptionName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("IsRecommended", FieldType.BOOLEAN, true, null, null),
062                new FieldDefinition("IsRequired", FieldType.BOOLEAN, true, null, null),
063                new FieldDefinition("RecommendedGeoCodeSelectorName", FieldType.ENTITY_NAME, false, null, null),
064                new FieldDefinition("RequiredGeoCodeSelectorName", FieldType.ENTITY_NAME, false, null, null),
065                new FieldDefinition("RecommendedItemSelectorName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("RequiredItemSelectorName", FieldType.ENTITY_NAME, false, null, null),
067                new FieldDefinition("RecommendedOrderSelectorName", FieldType.ENTITY_NAME, false, null, null),
068                new FieldDefinition("RequiredOrderSelectorName", FieldType.ENTITY_NAME, false, null, null),
069                new FieldDefinition("RecommendedShipmentSelectorName", FieldType.ENTITY_NAME, false, null, null),
070                new FieldDefinition("RequiredShipmentSelectorName", FieldType.ENTITY_NAME, false, null, null),
071                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
072                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
073                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
074        );
075    }
076
077    @Inject
078    CarrierControl carrierControl;
079
080    @Inject
081    SelectorControl selectorControl;
082
083    
084    /** Creates a new instance of CreateCarrierOptionCommand */
085    public CreateCarrierOptionCommand() {
086        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
087    }
088    
089    @Override
090    protected BaseResult execute() {
091        var result = CarrierResultFactory.getCreateCarrierOptionResult();
092        CarrierOption carrierOption = null;
093        var carrierName = form.getCarrierName();
094        var carrier = carrierControl.getCarrierByName(carrierName);
095        
096        if(carrier != null) {
097            var carrierParty = carrier.getParty();
098            var carrierOptionName = form.getCarrierOptionName();
099
100            carrierOption = carrierControl.getCarrierOptionByName(carrierParty, carrierOptionName);
101            
102            if(carrierOption == null) {
103                var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.POSTAL_ADDRESS.name());
104
105                if(selectorKind != null) {
106                    var selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name());
107
108                    if(selectorType != null) {
109                        var recommendedGeoCodeSelectorName = form.getRecommendedGeoCodeSelectorName();
110                        Selector recommendedGeoCodeSelector = null;
111
112                        if(recommendedGeoCodeSelectorName != null) {
113                            recommendedGeoCodeSelector = selectorControl.getSelectorByName(selectorType, recommendedGeoCodeSelectorName);
114                        }
115
116                        if(recommendedGeoCodeSelectorName == null || recommendedGeoCodeSelector != null) {
117                            var requiredGeoCodeSelectorName = form.getRequiredGeoCodeSelectorName();
118                            Selector requiredGeoCodeSelector = null;
119
120                            if(requiredGeoCodeSelectorName != null) {
121                                requiredGeoCodeSelector = selectorControl.getSelectorByName(selectorType, requiredGeoCodeSelectorName);
122                            }
123
124                            if(requiredGeoCodeSelectorName == null || requiredGeoCodeSelector != null) {
125                                selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ITEM.name());
126
127                                if(selectorKind != null) {
128                                    selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name());
129
130                                    if(selectorType != null) {
131                                        var recommendedItemSelectorName = form.getRecommendedItemSelectorName();
132                                        Selector recommendedItemSelector = null;
133
134                                        if(recommendedItemSelectorName != null) {
135                                            recommendedItemSelector = selectorControl.getSelectorByName(selectorType, recommendedItemSelectorName);
136                                        }
137
138                                        if(recommendedItemSelectorName == null || recommendedItemSelector != null) {
139                                            var requiredItemSelectorName = form.getRequiredItemSelectorName();
140                                            Selector requiredItemSelector = null;
141
142                                            if(requiredItemSelectorName != null) {
143                                                requiredItemSelector = selectorControl.getSelectorByName(selectorType, requiredItemSelectorName);
144                                            }
145
146                                            if(requiredItemSelectorName == null || requiredItemSelector != null) {
147                                                selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ORDER.name());
148
149                                                if(selectorKind != null) {
150                                                    selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name());
151
152                                                    if(selectorType != null) {
153                                                        var recommendedOrderSelectorName = form.getRecommendedOrderSelectorName();
154                                                        Selector recommendedOrderSelector = null;
155
156                                                        if(recommendedOrderSelectorName != null) {
157                                                            recommendedOrderSelector = selectorControl.getSelectorByName(selectorType, recommendedOrderSelectorName);
158                                                        }
159
160                                                        if(recommendedOrderSelectorName == null || recommendedOrderSelector != null) {
161                                                            var requiredOrderSelectorName = form.getRequiredOrderSelectorName();
162                                                            Selector requiredOrderSelector = null;
163
164                                                            if(requiredOrderSelectorName != null) {
165                                                                requiredOrderSelector = selectorControl.getSelectorByName(selectorType, requiredOrderSelectorName);
166                                                            }
167
168                                                            if(requiredOrderSelectorName == null || requiredOrderSelector != null) {
169                                                                selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.SHIPMENT.name());
170
171                                                                if(selectorKind != null) {
172                                                                    selectorType = selectorControl.getSelectorTypeByName(selectorKind, SelectorTypes.CARRIER_OPTION.name());
173
174                                                                    if(selectorType != null) {
175                                                                        var recommendedShipmentSelectorName = form.getRecommendedShipmentSelectorName();
176                                                                        Selector recommendedShipmentSelector = null;
177
178                                                                        if(recommendedShipmentSelectorName != null) {
179                                                                            recommendedShipmentSelector = selectorControl.getSelectorByName(selectorType, recommendedShipmentSelectorName);
180                                                                        }
181
182                                                                        if(recommendedShipmentSelectorName == null || recommendedShipmentSelector != null) {
183                                                                            var requiredShipmentSelectorName = form.getRequiredShipmentSelectorName();
184                                                                            Selector requiredShipmentSelector = null;
185
186                                                                            if(requiredShipmentSelectorName != null) {
187                                                                                requiredShipmentSelector = selectorControl.getSelectorByName(selectorType, requiredShipmentSelectorName);
188                                                                            }
189
190                                                                            if(requiredShipmentSelectorName == null || requiredShipmentSelector != null) {
191                                                                                var createdBy = getPartyPK();
192                                                                                var isRecommended = Boolean.valueOf(form.getIsRecommended());
193                                                                                var isRequired = Boolean.valueOf(form.getIsRequired());
194                                                                                var isDefault = Boolean.valueOf(form.getIsDefault());
195                                                                                var sortOrder = Integer.valueOf(form.getSortOrder());
196                                                                                var description = form.getDescription();
197
198                                                                                carrierOption = carrierControl.createCarrierOption(carrierParty,
199                                                                                        carrierOptionName, isRecommended, isRequired,
200                                                                                        recommendedGeoCodeSelector, requiredGeoCodeSelector,
201                                                                                        recommendedItemSelector, requiredItemSelector,
202                                                                                        recommendedOrderSelector, requiredOrderSelector,
203                                                                                        recommendedShipmentSelector, requiredShipmentSelector,
204                                                                                        isDefault, sortOrder, createdBy);
205
206                                                                                if(description != null) {
207                                                                                    carrierControl.createCarrierOptionDescription(carrierOption,
208                                                                                            getPreferredLanguage(), description, createdBy);
209                                                                                }
210                                                                            } else {
211                                                                                addExecutionError(ExecutionErrors.UnknownRequiredShipmentSelectorName.name(), requiredShipmentSelectorName);
212                                                                            }
213                                                                        } else {
214                                                                            addExecutionError(ExecutionErrors.UnknownRecommendedShipmentSelectorName.name(), recommendedShipmentSelectorName);
215                                                                        }
216                                                                    } else {
217                                                                        addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(),
218                                                                                SelectorKinds.SHIPMENT.name(),
219                                                                                SelectorTypes.CARRIER_OPTION.name());
220                                                                    }
221                                                                } else {
222                                                                    addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(),
223                                                                            SelectorKinds.SHIPMENT.name());
224                                                                }
225                                                            } else {
226                                                                addExecutionError(ExecutionErrors.UnknownRequiredOrderSelectorName.name(), requiredOrderSelectorName);
227                                                            }
228                                                        } else {
229                                                            addExecutionError(ExecutionErrors.UnknownRecommendedOrderSelectorName.name(), recommendedOrderSelectorName);
230                                                        }
231                                                    } else {
232                                                        addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.ORDER.name(),
233                                                                SelectorTypes.CARRIER_OPTION.name());
234                                                    }
235                                                } else {
236                                                    addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ORDER.name());
237                                                }
238                                            } else {
239                                                addExecutionError(ExecutionErrors.UnknownRequiredItemSelectorName.name(), requiredItemSelectorName);
240                                            }
241                                        } else {
242                                            addExecutionError(ExecutionErrors.UnknownRecommendedItemSelectorName.name(), recommendedItemSelectorName);
243                                        }
244                                    } else {
245                                        addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.ITEM.name(),
246                                                SelectorTypes.CARRIER_OPTION.name());
247                                    }
248                                } else {
249                                    addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ITEM.name());
250                                }
251                            } else {
252                                addExecutionError(ExecutionErrors.UnknownRequiredGeoCodeSelectorName.name(), requiredGeoCodeSelectorName);
253                            }
254                        } else {
255                            addExecutionError(ExecutionErrors.UnknownRecommendedGeoCodeSelectorName.name(), recommendedGeoCodeSelectorName);
256                        }
257                    } else {
258                        addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.POSTAL_ADDRESS.name(),
259                                SelectorTypes.CARRIER_OPTION.name());
260                    }
261                } else {
262                    addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.POSTAL_ADDRESS.name());
263                }
264            } else {
265                addExecutionError(ExecutionErrors.DuplicateCarrierOptionName.name(), carrierName, carrierOptionName);
266            }
267        } else {
268            addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
269        }
270        
271        if(carrierOption != null) {
272            result.setEntityRef(carrierOption.getPrimaryKey().getEntityRef());
273            result.setCarrierName(form.getCarrierName());
274            result.setCarrierOptionName(carrierOption.getLastDetail().getCarrierOptionName());
275        }
276
277        return result;
278    }
279    
280}