Source code

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.item.server.command;
018
019import com.echothree.control.user.item.common.edit.HarmonizedTariffScheduleCodeEdit;
020import com.echothree.control.user.item.common.edit.ItemEditFactory;
021import com.echothree.control.user.item.common.form.EditHarmonizedTariffScheduleCodeForm;
022import com.echothree.control.user.item.common.result.EditHarmonizedTariffScheduleCodeResult;
023import com.echothree.control.user.item.common.result.ItemResultFactory;
024import com.echothree.control.user.item.common.spec.HarmonizedTariffScheduleCodeSpec;
025import com.echothree.model.control.core.common.MimeTypeUsageTypes;
026import com.echothree.model.control.core.server.logic.MimeTypeLogic;
027import com.echothree.model.control.geo.server.control.GeoControl;
028import com.echothree.model.control.item.server.control.ItemControl;
029import com.echothree.model.control.party.common.PartyTypes;
030import com.echothree.model.control.security.common.SecurityRoleGroups;
031import com.echothree.model.control.security.common.SecurityRoles;
032import com.echothree.model.data.core.server.entity.MimeType;
033import com.echothree.model.data.geo.server.entity.GeoCode;
034import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCode;
035import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeUnit;
036import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.EditMode;
041import com.echothree.util.server.control.BaseAbstractEditCommand;
042import com.echothree.util.server.control.CommandSecurityDefinition;
043import com.echothree.util.server.control.PartyTypeDefinition;
044import com.echothree.util.server.control.SecurityRoleDefinition;
045import com.echothree.util.server.persistence.Session;
046import java.util.Arrays;
047import java.util.Collections;
048import java.util.List;
049import javax.enterprise.context.RequestScoped;
050
051@RequestScoped
052public class EditHarmonizedTariffScheduleCodeCommand
053        extends BaseAbstractEditCommand<HarmonizedTariffScheduleCodeSpec, HarmonizedTariffScheduleCodeEdit, EditHarmonizedTariffScheduleCodeResult, HarmonizedTariffScheduleCode, HarmonizedTariffScheduleCode> {
054
055    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
056    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
057    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
058
059    static {
060        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
061                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
062                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
063                        new SecurityRoleDefinition(SecurityRoleGroups.HarmonizedTariffScheduleCode.name(), SecurityRoles.Edit.name())
064                        )))
065                )));
066
067        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.ENTITY_NAME, true, null, null)
070                ));
071
072        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
073                new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.ENTITY_NAME, true, null, null),
074                new FieldDefinition("FirstHarmonizedTariffScheduleCodeUnitName", FieldType.ENTITY_NAME, false, null, null),
075                new FieldDefinition("SecondHarmonizedTariffScheduleCodeUnitName", FieldType.ENTITY_NAME, false, null, null),
076                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
077                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
078                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
079                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
080                new FieldDefinition("Overview", FieldType.STRING, false, null, null)
081                ));
082    }
083
084    /** Creates a new instance of EditHarmonizedTariffScheduleCodeCommand */
085    public EditHarmonizedTariffScheduleCodeCommand() {
086        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
087    }
088
089    @Override
090    public EditHarmonizedTariffScheduleCodeResult getResult() {
091        return ItemResultFactory.getEditHarmonizedTariffScheduleCodeResult();
092    }
093
094    @Override
095    public HarmonizedTariffScheduleCodeEdit getEdit() {
096        return ItemEditFactory.getHarmonizedTariffScheduleCodeEdit();
097    }
098
099    GeoCode countryGeoCode;
100
101    @Override
102    public HarmonizedTariffScheduleCode getEntity(EditHarmonizedTariffScheduleCodeResult result) {
103        var geoControl = Session.getModelController(GeoControl.class);
104        HarmonizedTariffScheduleCode harmonizedTariffScheduleCode = null;
105        var countryName = spec.getCountryName();
106
107        countryGeoCode = geoControl.getCountryByAlias(countryName);
108
109        if(countryGeoCode != null) {
110            var itemControl = Session.getModelController(ItemControl.class);
111            var harmonizedTariffScheduleCodeName = spec.getHarmonizedTariffScheduleCodeName();
112
113            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
114                harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(countryGeoCode, harmonizedTariffScheduleCodeName);
115            } else { // EditMode.UPDATE
116                harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByNameForUpdate(countryGeoCode, harmonizedTariffScheduleCodeName);
117            }
118
119            if(harmonizedTariffScheduleCode == null) {
120                addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeName.name(), countryName, harmonizedTariffScheduleCodeName);
121            }
122        } else {
123            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
124        }
125
126        return harmonizedTariffScheduleCode;
127    }
128
129    @Override
130    public HarmonizedTariffScheduleCode getLockEntity(HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) {
131        return harmonizedTariffScheduleCode;
132    }
133
134    @Override
135    public void fillInResult(EditHarmonizedTariffScheduleCodeResult result, HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) {
136        var itemControl = Session.getModelController(ItemControl.class);
137
138        result.setHarmonizedTariffScheduleCode(itemControl.getHarmonizedTariffScheduleCodeTransfer(getUserVisit(), harmonizedTariffScheduleCode));
139    }
140
141    MimeType overviewMimeType;
142    
143    HarmonizedTariffScheduleCodeUnit firstHarmonizedTariffScheduleCodeUnit;
144    HarmonizedTariffScheduleCodeUnit secondHarmonizedTariffScheduleCodeUnit;
145
146    @Override
147    public void doLock(HarmonizedTariffScheduleCodeEdit edit, HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) {
148        var itemControl = Session.getModelController(ItemControl.class);
149        var harmonizedTariffScheduleCodeTranslation = itemControl.getHarmonizedTariffScheduleCodeTranslation(harmonizedTariffScheduleCode, getPreferredLanguage());
150        var harmonizedTariffScheduleCodeDetail = harmonizedTariffScheduleCode.getLastDetail();
151
152        firstHarmonizedTariffScheduleCodeUnit = harmonizedTariffScheduleCodeDetail.getFirstHarmonizedTariffScheduleCodeUnit();
153        secondHarmonizedTariffScheduleCodeUnit = harmonizedTariffScheduleCodeDetail.getSecondHarmonizedTariffScheduleCodeUnit();
154        
155        edit.setHarmonizedTariffScheduleCodeName(harmonizedTariffScheduleCodeDetail.getHarmonizedTariffScheduleCodeName());
156        edit.setFirstHarmonizedTariffScheduleCodeUnitName(firstHarmonizedTariffScheduleCodeUnit == null ? null : firstHarmonizedTariffScheduleCodeUnit.getLastDetail().getHarmonizedTariffScheduleCodeUnitName());
157        edit.setSecondHarmonizedTariffScheduleCodeUnitName(secondHarmonizedTariffScheduleCodeUnit == null ? null : secondHarmonizedTariffScheduleCodeUnit.getLastDetail().getHarmonizedTariffScheduleCodeUnitName());
158        edit.setIsDefault(harmonizedTariffScheduleCodeDetail.getIsDefault().toString());
159        edit.setSortOrder(harmonizedTariffScheduleCodeDetail.getSortOrder().toString());
160
161        if(harmonizedTariffScheduleCodeTranslation != null) {
162            overviewMimeType = harmonizedTariffScheduleCodeTranslation.getOverviewMimeType();
163            
164            edit.setDescription(harmonizedTariffScheduleCodeTranslation.getDescription());
165            edit.setOverviewMimeTypeName(overviewMimeType == null? null: overviewMimeType.getLastDetail().getMimeTypeName());
166            edit.setOverview(harmonizedTariffScheduleCodeTranslation.getOverview());
167        }
168    }
169    
170    @Override
171    public void canUpdate(HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) {
172        var itemControl = Session.getModelController(ItemControl.class);
173        var geoCodeDetail = countryGeoCode.getLastDetail();
174        var harmonizedTariffScheduleCodeName = edit.getHarmonizedTariffScheduleCodeName();
175        var duplicateHarmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(countryGeoCode, harmonizedTariffScheduleCodeName);
176
177        if(duplicateHarmonizedTariffScheduleCode != null && !harmonizedTariffScheduleCode.equals(duplicateHarmonizedTariffScheduleCode)) {
178            addExecutionError(ExecutionErrors.DuplicateHarmonizedTariffScheduleCodeName.name(), geoCodeDetail.getGeoCodeName(), harmonizedTariffScheduleCodeName);
179        } else {
180            var overviewMimeTypeName = edit.getOverviewMimeTypeName();
181            var overview = edit.getOverview();
182
183            overviewMimeType = MimeTypeLogic.getInstance().checkMimeType(this, overviewMimeTypeName, overview, MimeTypeUsageTypes.TEXT.name(),
184                    ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
185                    ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
186            
187            if(!hasExecutionErrors()) {
188                var firstHarmonizedTariffScheduleCodeUnitName = edit.getFirstHarmonizedTariffScheduleCodeUnitName();
189                
190                firstHarmonizedTariffScheduleCodeUnit = firstHarmonizedTariffScheduleCodeUnitName == null ? null : itemControl.getHarmonizedTariffScheduleCodeUnitByName(firstHarmonizedTariffScheduleCodeUnitName);
191                
192                if(firstHarmonizedTariffScheduleCodeUnitName == null || firstHarmonizedTariffScheduleCodeUnit != null) {
193                    var secondHarmonizedTariffScheduleCodeUnitName = edit.getSecondHarmonizedTariffScheduleCodeUnitName();
194                    
195                    secondHarmonizedTariffScheduleCodeUnit = secondHarmonizedTariffScheduleCodeUnitName == null ? null : itemControl.getHarmonizedTariffScheduleCodeUnitByName(secondHarmonizedTariffScheduleCodeUnitName);
196
197                    if(secondHarmonizedTariffScheduleCodeUnitName != null && secondHarmonizedTariffScheduleCodeUnit == null) {
198                        addExecutionError(ExecutionErrors.UnknownSecondHarmonizedTariffScheduleCodeUnitName.name(), secondHarmonizedTariffScheduleCodeUnitName);
199                    }
200                } else {
201                    addExecutionError(ExecutionErrors.UnknownFirstHarmonizedTariffScheduleCodeUnitName.name(), firstHarmonizedTariffScheduleCodeUnitName);
202                }
203            }
204        }
205    }
206
207    @Override
208    public void doUpdate(HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) {
209        var itemControl = Session.getModelController(ItemControl.class);
210        var partyPK = getPartyPK();
211        var harmonizedTariffScheduleCodeDetailValue = itemControl.getHarmonizedTariffScheduleCodeDetailValueForUpdate(harmonizedTariffScheduleCode);
212        var harmonizedTariffScheduleCodeTranslation = itemControl.getHarmonizedTariffScheduleCodeTranslationForUpdate(harmonizedTariffScheduleCode, getPreferredLanguage());
213        var description = edit.getDescription();
214        var overview = edit.getOverview();
215
216        harmonizedTariffScheduleCodeDetailValue.setHarmonizedTariffScheduleCodeName(edit.getHarmonizedTariffScheduleCodeName());
217        harmonizedTariffScheduleCodeDetailValue.setFirstHarmonizedTariffScheduleCodeUnitPK(firstHarmonizedTariffScheduleCodeUnit == null ? null : firstHarmonizedTariffScheduleCodeUnit.getPrimaryKey());
218        harmonizedTariffScheduleCodeDetailValue.setSecondHarmonizedTariffScheduleCodeUnitPK(secondHarmonizedTariffScheduleCodeUnit == null ? null : secondHarmonizedTariffScheduleCodeUnit.getPrimaryKey());
219        harmonizedTariffScheduleCodeDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
220        harmonizedTariffScheduleCodeDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
221
222        itemControl.updateHarmonizedTariffScheduleCodeFromValue(harmonizedTariffScheduleCodeDetailValue, partyPK);
223
224        if(harmonizedTariffScheduleCodeTranslation == null && (description != null || overview != null)) {
225            itemControl.createHarmonizedTariffScheduleCodeTranslation(harmonizedTariffScheduleCode, getPreferredLanguage(), description, overviewMimeType, overview, partyPK);
226        } else if(harmonizedTariffScheduleCodeTranslation != null && (description == null && overview == null)) {
227            itemControl.deleteHarmonizedTariffScheduleCodeTranslation(harmonizedTariffScheduleCodeTranslation, partyPK);
228        } else if(harmonizedTariffScheduleCodeTranslation != null && (description != null || overview != null)) {
229            var harmonizedTariffScheduleCodeTranslationValue = itemControl.getHarmonizedTariffScheduleCodeTranslationValue(harmonizedTariffScheduleCodeTranslation);
230
231            harmonizedTariffScheduleCodeTranslationValue.setDescription(description);
232            harmonizedTariffScheduleCodeTranslationValue.setOverviewMimeTypePK(overviewMimeType == null? null: overviewMimeType.getPrimaryKey());
233            harmonizedTariffScheduleCodeTranslationValue.setOverview(overview);
234            itemControl.updateHarmonizedTariffScheduleCodeTranslationFromValue(harmonizedTariffScheduleCodeTranslationValue, partyPK);
235        }
236    }
237
238}