001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.item.server.command;
018
019import com.echothree.control.user.item.common.form.CreateHarmonizedTariffScheduleCodeForm;
020import com.echothree.model.control.core.common.MimeTypeUsageTypes;
021import com.echothree.model.control.core.server.logic.MimeTypeLogic;
022import com.echothree.model.control.geo.server.control.GeoControl;
023import com.echothree.model.control.item.server.control.ItemControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.core.server.entity.MimeType;
028import com.echothree.model.data.geo.server.entity.GeoCode;
029import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCode;
030import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeUnit;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class CreateHarmonizedTariffScheduleCodeCommand
046        extends BaseSimpleCommand<CreateHarmonizedTariffScheduleCodeForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                    new SecurityRoleDefinition(SecurityRoleGroups.HarmonizedTariffScheduleCode.name(), SecurityRoles.Create.name())
056                    )))
057                )));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.HARMONIZED_TARIFF_SCHEDULE_CODE, true, null, null),
062                new FieldDefinition("FirstHarmonizedTariffScheduleCodeUnitName", FieldType.ENTITY_NAME, false, null, null),
063                new FieldDefinition("SecondHarmonizedTariffScheduleCodeUnitName", FieldType.ENTITY_NAME, false, null, null),
064                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
065                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
066                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
067                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
068                new FieldDefinition("Overview", FieldType.STRING, false, null, null)
069                ));
070    }
071    
072    /** Creates a new instance of CreateHarmonizedTariffScheduleCodeCommand */
073    public CreateHarmonizedTariffScheduleCodeCommand(UserVisitPK userVisitPK, CreateHarmonizedTariffScheduleCodeForm form) {
074        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var geoControl = Session.getModelController(GeoControl.class);
080        String countryName = form.getCountryName();
081        GeoCode geoCode = geoControl.getCountryByAlias(countryName);
082        
083        if(geoCode != null) {
084            var itemControl = Session.getModelController(ItemControl.class);
085            String harmonizedTariffScheduleCodeName = form.getHarmonizedTariffScheduleCodeName();
086            HarmonizedTariffScheduleCode harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(geoCode, harmonizedTariffScheduleCodeName);
087            
088            if(harmonizedTariffScheduleCode == null) {
089                String firstHarmonizedTariffScheduleCodeUnitName = form.getFirstHarmonizedTariffScheduleCodeUnitName();
090                HarmonizedTariffScheduleCodeUnit firstHarmonizedTariffScheduleCodeUnit = firstHarmonizedTariffScheduleCodeUnitName == null ? null : itemControl.getHarmonizedTariffScheduleCodeUnitByName(firstHarmonizedTariffScheduleCodeUnitName);
091                
092                if(firstHarmonizedTariffScheduleCodeUnitName == null || firstHarmonizedTariffScheduleCodeUnit != null) {
093                    String secondHarmonizedTariffScheduleCodeUnitName = form.getSecondHarmonizedTariffScheduleCodeUnitName();
094                    HarmonizedTariffScheduleCodeUnit secondHarmonizedTariffScheduleCodeUnit = secondHarmonizedTariffScheduleCodeUnitName == null ? null : itemControl.getHarmonizedTariffScheduleCodeUnitByName(secondHarmonizedTariffScheduleCodeUnitName);
095
096                    if(secondHarmonizedTariffScheduleCodeUnitName == null || secondHarmonizedTariffScheduleCodeUnit != null) {
097                        String overview = form.getOverview();
098                        MimeType overviewMimeType = MimeTypeLogic.getInstance().checkMimeType(this, form.getOverviewMimeTypeName(), overview, MimeTypeUsageTypes.TEXT.name(),
099                                ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
100                                ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
101
102                        if(!hasExecutionErrors()) {
103                            var partyPK = getPartyPK();
104                            var isDefault = Boolean.valueOf(form.getIsDefault());
105                            var sortOrder = Integer.valueOf(form.getSortOrder());
106                            var description = form.getDescription();
107
108                            harmonizedTariffScheduleCode = itemControl.createHarmonizedTariffScheduleCode(geoCode, harmonizedTariffScheduleCodeName,
109                                    firstHarmonizedTariffScheduleCodeUnit, secondHarmonizedTariffScheduleCodeUnit, isDefault, sortOrder, partyPK);
110
111                            if(description != null) {
112                                itemControl.createHarmonizedTariffScheduleCodeTranslation(harmonizedTariffScheduleCode, getPreferredLanguage(), description,
113                                        overviewMimeType, overview, partyPK);
114                            }
115                        }
116                    } else {
117                        addExecutionError(ExecutionErrors.UnknownSecondHarmonizedTariffScheduleCodeUnitName.name(), secondHarmonizedTariffScheduleCodeUnitName);
118                    }
119                } else {
120                    addExecutionError(ExecutionErrors.UnknownFirstHarmonizedTariffScheduleCodeUnitName.name(), firstHarmonizedTariffScheduleCodeUnitName);
121                }
122            } else {
123                addExecutionError(ExecutionErrors.DuplicateHarmonizedTariffScheduleCodeName.name(), countryName, harmonizedTariffScheduleCodeName);
124            }
125        } else {
126            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
127        }
128        
129        return null;
130    }
131    
132}