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.form.CreateCarrierForm;
020import com.echothree.control.user.carrier.common.result.CarrierResultFactory;
021import com.echothree.model.control.accounting.server.control.AccountingControl;
022import com.echothree.model.control.carrier.server.control.CarrierControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.control.selector.common.SelectorKinds;
028import com.echothree.model.control.selector.common.SelectorTypes;
029import com.echothree.model.control.selector.server.control.SelectorControl;
030import com.echothree.model.data.accounting.server.entity.Currency;
031import com.echothree.model.data.selector.server.entity.Selector;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.persistence.BasePK;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.server.control.BaseSimpleCommand;
039import com.echothree.util.server.control.CommandSecurityDefinition;
040import com.echothree.util.server.control.PartyTypeDefinition;
041import com.echothree.util.server.control.SecurityRoleDefinition;
042import com.echothree.util.server.persistence.Session;
043import java.util.Arrays;
044import java.util.Collections;
045import java.util.List;
046import javax.enterprise.context.RequestScoped;
047
048@RequestScoped
049public class CreateCarrierCommand
050        extends BaseSimpleCommand<CreateCarrierForm> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
054    
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
059                        new SecurityRoleDefinition(SecurityRoleGroups.Carrier.name(), SecurityRoles.Create.name())
060                        )))
061                )));
062
063        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("CarrierTypeName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("Name", FieldType.STRING, true, 1L, 60L),
067                new FieldDefinition("PreferredLanguageIsoName", FieldType.ENTITY_NAME, false, null, null),
068                new FieldDefinition("PreferredCurrencyIsoName", FieldType.ENTITY_NAME, false, null, null),
069                new FieldDefinition("PreferredJavaTimeZoneName", FieldType.TIME_ZONE_NAME, false, null, null),
070                new FieldDefinition("PreferredDateTimeFormatName", FieldType.ENTITY_NAME, false, null, null),
071                new FieldDefinition("GeoCodeSelectorName", FieldType.ENTITY_NAME, false, null, null),
072                new FieldDefinition("ItemSelectorName", FieldType.ENTITY_NAME, false, null, null),
073                new FieldDefinition("AccountValidationPattern", FieldType.REGULAR_EXPRESSION, false, null, null),
074                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
075                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
076                ));
077    }
078    
079    /** Creates a new instance of CreateCarrierCommand */
080    public CreateCarrierCommand() {
081        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
082    }
083    
084    @Override
085    protected BaseResult execute() {
086        var carrierControl = Session.getModelController(CarrierControl.class);
087        var result = CarrierResultFactory.getCreateCarrierResult();
088        var carrierName = form.getCarrierName();
089        var carrier = carrierControl.getCarrierByName(carrierName);
090        
091        if(carrier == null) {
092            var carrierTypeName = form.getCarrierTypeName();
093            var carrierType = carrierControl.getCarrierTypeByName(carrierTypeName);
094            
095            if(carrierType != null) {
096                var partyControl = Session.getModelController(PartyControl.class);
097                var preferredLanguageIsoName = form.getPreferredLanguageIsoName();
098                var preferredLanguage = preferredLanguageIsoName == null? null: partyControl.getLanguageByIsoName(preferredLanguageIsoName);
099                
100                if(preferredLanguageIsoName == null || (preferredLanguage != null)) {
101                    var preferredJavaTimeZoneName = form.getPreferredJavaTimeZoneName();
102                    var preferredTimeZone = preferredJavaTimeZoneName == null? null: partyControl.getTimeZoneByJavaName(preferredJavaTimeZoneName);
103                    
104                    if(preferredJavaTimeZoneName == null || (preferredTimeZone != null)) {
105                        var preferredDateTimeFormatName = form.getPreferredDateTimeFormatName();
106                        var preferredDateTimeFormat = preferredDateTimeFormatName == null? null: partyControl.getDateTimeFormatByName(preferredDateTimeFormatName);
107                        
108                        if(preferredDateTimeFormatName == null || (preferredDateTimeFormat != null)) {
109                            var preferredCurrencyIsoName = form.getPreferredCurrencyIsoName();
110                            Currency preferredCurrency;
111                            
112                            if(preferredCurrencyIsoName == null)
113                                preferredCurrency = null;
114                            else {
115                                var accountingControl = Session.getModelController(AccountingControl.class);
116                                preferredCurrency = accountingControl.getCurrencyByIsoName(preferredCurrencyIsoName);
117                            }
118                            
119                            if(preferredCurrencyIsoName == null || (preferredCurrency != null)) {
120                                var geoCodeSelectorName = form.getGeoCodeSelectorName();
121                                Selector geoCodeSelector = null;
122
123                                if(geoCodeSelectorName != null) {
124                                    var selectorControl = Session.getModelController(SelectorControl.class);
125                                    var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.POSTAL_ADDRESS.name());
126
127                                    if(selectorKind != null) {
128                                        var selectorType = selectorControl.getSelectorTypeByName(selectorKind,
129                                                SelectorTypes.CARRIER.name());
130
131                                        if(selectorType != null) {
132                                            geoCodeSelector = selectorControl.getSelectorByName(selectorType, geoCodeSelectorName);
133                                        } else {
134                                            addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.POSTAL_ADDRESS.name(),
135                                                    SelectorTypes.CARRIER.name());
136                                        }
137                                    } else {
138                                        addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.POSTAL_ADDRESS.name());
139                                    }
140                                }
141
142                                if(geoCodeSelectorName == null || geoCodeSelector != null) {
143                                    var itemSelectorName = form.getItemSelectorName();
144                                    Selector itemSelector = null;
145
146                                    if(itemSelectorName != null) {
147                                        var selectorControl = Session.getModelController(SelectorControl.class);
148                                        var selectorKind = selectorControl.getSelectorKindByName(SelectorKinds.ITEM.name());
149
150                                        if(selectorKind != null) {
151                                            var selectorType = selectorControl.getSelectorTypeByName(selectorKind,
152                                                    SelectorTypes.CARRIER.name());
153
154                                            if(selectorType != null) {
155                                                itemSelector = selectorControl.getSelectorByName(selectorType, itemSelectorName);
156                                            } else {
157                                                addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), SelectorKinds.ITEM.name(),
158                                                        SelectorTypes.CARRIER.name());
159                                            }
160                                        } else {
161                                            addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), SelectorKinds.ITEM.name());
162                                        }
163                                    }
164
165                                    if(itemSelectorName == null || itemSelector != null) {
166                                        var partyType = partyControl.getPartyTypeByName(PartyTypes.CARRIER.name());
167                                        BasePK createdBy = getPartyPK();
168                                        var name = form.getName();
169                                        var accountValidationPattern = form.getAccountValidationPattern();
170                                        var isDefault = Boolean.valueOf(form.getIsDefault());
171                                        var sortOrder = Integer.valueOf(form.getSortOrder());
172
173                                        var party = partyControl.createParty(null, partyType, preferredLanguage, preferredCurrency, preferredTimeZone,
174                                                preferredDateTimeFormat, createdBy);
175                                        partyControl.createPartyGroup(party, name, createdBy);
176                                        carrier = carrierControl.createCarrier(party, carrierName, carrierType, geoCodeSelector, itemSelector,
177                                                accountValidationPattern, isDefault, sortOrder, createdBy);
178                                    } else {
179                                        addExecutionError(ExecutionErrors.UnknownItemSelectorName.name(), itemSelectorName);
180                                    }
181                                } else {
182                                    addExecutionError(ExecutionErrors.UnknownGeoCodeSelectorName.name(), geoCodeSelectorName);
183                                }
184                            } else {
185                                addExecutionError(ExecutionErrors.UnknownCurrencyIsoName.name(), preferredCurrencyIsoName);
186                            }
187                        } else {
188                            addExecutionError(ExecutionErrors.UnknownDateTimeFormatName.name(), preferredDateTimeFormatName);
189                        }
190                    } else {
191                        addExecutionError(ExecutionErrors.UnknownJavaTimeZoneName.name(), preferredJavaTimeZoneName);
192                    }
193                } else {
194                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), preferredLanguageIsoName);
195                }
196            } else {
197                addExecutionError(ExecutionErrors.UnknownCarrierTypeName.name(), carrierName, carrierTypeName);
198            }
199        } else {
200            addExecutionError(ExecutionErrors.DuplicateCarrierName.name(), carrierName);
201        }
202        
203        if(carrier != null) {
204            var party = carrier.getParty();
205            
206            result.setEntityRef(party.getPrimaryKey().getEntityRef());
207            result.setCarrierName(carrier.getCarrierName());
208            result.setPartyName(party.getLastDetail().getPartyName());
209        }
210        
211        return result;
212    }
213    
214}