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.item.server.command;
018
019import com.echothree.control.user.item.common.edit.HarmonizedTariffScheduleCodeTranslationEdit;
020import com.echothree.control.user.item.common.edit.ItemEditFactory;
021import com.echothree.control.user.item.common.form.EditHarmonizedTariffScheduleCodeTranslationForm;
022import com.echothree.control.user.item.common.result.EditHarmonizedTariffScheduleCodeTranslationResult;
023import com.echothree.control.user.item.common.result.ItemResultFactory;
024import com.echothree.control.user.item.common.spec.HarmonizedTariffScheduleCodeTranslationSpec;
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.party.server.control.PartyControl;
031import com.echothree.model.control.security.common.SecurityRoleGroups;
032import com.echothree.model.control.security.common.SecurityRoles;
033import com.echothree.model.data.core.server.entity.MimeType;
034import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCode;
035import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeTranslation;
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.List;
047import javax.enterprise.context.Dependent;
048
049@Dependent
050public class EditHarmonizedTariffScheduleCodeTranslationCommand
051        extends BaseAbstractEditCommand<HarmonizedTariffScheduleCodeTranslationSpec, HarmonizedTariffScheduleCodeTranslationEdit, EditHarmonizedTariffScheduleCodeTranslationResult, HarmonizedTariffScheduleCodeTranslation, HarmonizedTariffScheduleCode> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
061                        new SecurityRoleDefinition(SecurityRoleGroups.HarmonizedTariffScheduleCode.name(), SecurityRoles.Translation.name())
062                        ))
063                ));
064
065        SPEC_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
068                );
069
070        EDIT_FIELD_DEFINITIONS = List.of(
071                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L),
072                new FieldDefinition("OverviewMimeTypeName", FieldType.MIME_TYPE, false, null, null),
073                new FieldDefinition("Overview", FieldType.STRING, false, null, null)
074                );
075    }
076
077    /** Creates a new instance of EditHarmonizedTariffScheduleCodeTranslationCommand */
078    public EditHarmonizedTariffScheduleCodeTranslationCommand() {
079        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081
082    @Override
083    public EditHarmonizedTariffScheduleCodeTranslationResult getResult() {
084        return ItemResultFactory.getEditHarmonizedTariffScheduleCodeTranslationResult();
085    }
086
087    @Override
088    public HarmonizedTariffScheduleCodeTranslationEdit getEdit() {
089        return ItemEditFactory.getHarmonizedTariffScheduleCodeTranslationEdit();
090    }
091
092    @Override
093    public HarmonizedTariffScheduleCodeTranslation getEntity(EditHarmonizedTariffScheduleCodeTranslationResult result) {
094        var geoControl = Session.getModelController(GeoControl.class);
095        HarmonizedTariffScheduleCodeTranslation harmonizedTariffScheduleCodeTranslation = null;
096        var countryName = spec.getCountryName();
097        var countryGeoCode = geoControl.getCountryByAlias(countryName);
098
099        if(countryGeoCode != null) {
100            var itemControl = Session.getModelController(ItemControl.class);
101            var harmonizedTariffScheduleCodeName = spec.getHarmonizedTariffScheduleCodeName();
102            var harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(countryGeoCode, harmonizedTariffScheduleCodeName);
103
104            if(harmonizedTariffScheduleCode != null) {
105                var partyControl = Session.getModelController(PartyControl.class);
106                var languageIsoName = spec.getLanguageIsoName();
107                var language = partyControl.getLanguageByIsoName(languageIsoName);
108
109                if(language != null) {
110                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
111                        harmonizedTariffScheduleCodeTranslation = itemControl.getHarmonizedTariffScheduleCodeTranslation(harmonizedTariffScheduleCode, language);
112                    } else { // EditMode.UPDATE
113                        harmonizedTariffScheduleCodeTranslation = itemControl.getHarmonizedTariffScheduleCodeTranslationForUpdate(harmonizedTariffScheduleCode, language);
114                    }
115
116                    if(harmonizedTariffScheduleCodeTranslation == null) {
117                        addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeTranslation.name(), countryName, harmonizedTariffScheduleCodeName, languageIsoName);
118                    }
119                } else {
120                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
121                }
122            } else {
123                addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeName.name(), countryName, harmonizedTariffScheduleCodeName);
124            }
125        } else {
126            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), countryName);
127        }
128
129        return harmonizedTariffScheduleCodeTranslation;
130    }
131
132    @Override
133    public HarmonizedTariffScheduleCode getLockEntity(HarmonizedTariffScheduleCodeTranslation harmonizedTariffScheduleCodeTranslation) {
134        return harmonizedTariffScheduleCodeTranslation.getHarmonizedTariffScheduleCode();
135    }
136
137    @Override
138    public void fillInResult(EditHarmonizedTariffScheduleCodeTranslationResult result, HarmonizedTariffScheduleCodeTranslation harmonizedTariffScheduleCodeTranslation) {
139        var itemControl = Session.getModelController(ItemControl.class);
140
141        result.setHarmonizedTariffScheduleCodeTranslation(itemControl.getHarmonizedTariffScheduleCodeTranslationTransfer(getUserVisit(), harmonizedTariffScheduleCodeTranslation));
142    }
143
144    MimeType overviewMimeType;
145    
146    @Override
147    public void doLock(HarmonizedTariffScheduleCodeTranslationEdit edit, HarmonizedTariffScheduleCodeTranslation harmonizedTariffScheduleCodeTranslation) {
148        overviewMimeType = harmonizedTariffScheduleCodeTranslation.getOverviewMimeType();
149        
150        edit.setDescription(harmonizedTariffScheduleCodeTranslation.getDescription());
151        edit.setOverviewMimeTypeName(overviewMimeType == null? null: overviewMimeType.getLastDetail().getMimeTypeName());
152        edit.setOverview(harmonizedTariffScheduleCodeTranslation.getOverview());
153    }
154
155    @Override
156    protected void canUpdate(HarmonizedTariffScheduleCodeTranslation harmonizedTariffScheduleCodeTranslation) {
157        var overviewMimeTypeName = edit.getOverviewMimeTypeName();
158        var overview = edit.getOverview();
159        
160        overviewMimeType = MimeTypeLogic.getInstance().checkMimeType(this, overviewMimeTypeName, overview, MimeTypeUsageTypes.TEXT.name(),
161                ExecutionErrors.MissingRequiredOverviewMimeTypeName.name(), ExecutionErrors.MissingRequiredOverview.name(),
162                ExecutionErrors.UnknownOverviewMimeTypeName.name(), ExecutionErrors.UnknownOverviewMimeTypeUsage.name());
163    }
164    
165    @Override
166    public void doUpdate(HarmonizedTariffScheduleCodeTranslation harmonizedTariffScheduleCodeTranslation) {
167        var itemControl = Session.getModelController(ItemControl.class);
168        var harmonizedTariffScheduleCodeTranslationValue = itemControl.getHarmonizedTariffScheduleCodeTranslationValue(harmonizedTariffScheduleCodeTranslation);
169
170        harmonizedTariffScheduleCodeTranslationValue.setDescription(edit.getDescription());
171        harmonizedTariffScheduleCodeTranslationValue.setOverviewMimeTypePK(overviewMimeType == null ? null : overviewMimeType.getPrimaryKey());
172        harmonizedTariffScheduleCodeTranslationValue.setOverview(edit.getOverview());
173
174        itemControl.updateHarmonizedTariffScheduleCodeTranslationFromValue(harmonizedTariffScheduleCodeTranslationValue, getPartyPK());
175    }
176
177}