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.HarmonizedTariffScheduleCodeUnitEdit;
020import com.echothree.control.user.item.common.edit.ItemEditFactory;
021import com.echothree.control.user.item.common.form.EditHarmonizedTariffScheduleCodeUnitForm;
022import com.echothree.control.user.item.common.result.EditHarmonizedTariffScheduleCodeUnitResult;
023import com.echothree.control.user.item.common.result.ItemResultFactory;
024import com.echothree.control.user.item.common.spec.HarmonizedTariffScheduleCodeUnitSpec;
025import com.echothree.model.control.item.server.control.ItemControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeUnit;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
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 EditHarmonizedTariffScheduleCodeUnitCommand
045        extends BaseAbstractEditCommand<HarmonizedTariffScheduleCodeUnitSpec, HarmonizedTariffScheduleCodeUnitEdit, EditHarmonizedTariffScheduleCodeUnitResult, HarmonizedTariffScheduleCodeUnit, HarmonizedTariffScheduleCodeUnit> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.HarmonizedTariffScheduleCodeUnit.name(), SecurityRoles.Edit.name())
056                ))
057        ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("HarmonizedTariffScheduleCodeUnitName", FieldType.ENTITY_NAME, true, null, null)
061        );
062
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("HarmonizedTariffScheduleCodeUnitName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068        );
069    }
070
071    @Inject
072    ItemControl itemControl;
073
074    /** Creates a new instance of EditHarmonizedTariffScheduleCodeUnitCommand */
075    public EditHarmonizedTariffScheduleCodeUnitCommand() {
076        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078
079    @Override
080    public EditHarmonizedTariffScheduleCodeUnitResult getResult() {
081        return ItemResultFactory.getEditHarmonizedTariffScheduleCodeUnitResult();
082    }
083
084    @Override
085    public HarmonizedTariffScheduleCodeUnitEdit getEdit() {
086        return ItemEditFactory.getHarmonizedTariffScheduleCodeUnitEdit();
087    }
088
089    @Override
090    public HarmonizedTariffScheduleCodeUnit getEntity(EditHarmonizedTariffScheduleCodeUnitResult result) {
091        HarmonizedTariffScheduleCodeUnit harmonizedTariffScheduleCodeUnit;
092        var harmonizedTariffScheduleCodeUnitName = spec.getHarmonizedTariffScheduleCodeUnitName();
093
094        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095            harmonizedTariffScheduleCodeUnit = itemControl.getHarmonizedTariffScheduleCodeUnitByName(harmonizedTariffScheduleCodeUnitName);
096        } else { // EditMode.UPDATE
097            harmonizedTariffScheduleCodeUnit = itemControl.getHarmonizedTariffScheduleCodeUnitByNameForUpdate(harmonizedTariffScheduleCodeUnitName);
098        }
099
100        if(harmonizedTariffScheduleCodeUnit == null) {
101            addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUnitName.name(), harmonizedTariffScheduleCodeUnitName);
102        }
103
104        return harmonizedTariffScheduleCodeUnit;
105    }
106
107    @Override
108    public HarmonizedTariffScheduleCodeUnit getLockEntity(HarmonizedTariffScheduleCodeUnit harmonizedTariffScheduleCodeUnit) {
109        return harmonizedTariffScheduleCodeUnit;
110    }
111
112    @Override
113    public void fillInResult(EditHarmonizedTariffScheduleCodeUnitResult result, HarmonizedTariffScheduleCodeUnit harmonizedTariffScheduleCodeUnit) {
114        result.setHarmonizedTariffScheduleCodeUnit(itemControl.getHarmonizedTariffScheduleCodeUnitTransfer(getUserVisit(), harmonizedTariffScheduleCodeUnit));
115    }
116
117    @Override
118    public void doLock(HarmonizedTariffScheduleCodeUnitEdit edit, HarmonizedTariffScheduleCodeUnit harmonizedTariffScheduleCodeUnit) {
119        var harmonizedTariffScheduleCodeUnitDescription = itemControl.getHarmonizedTariffScheduleCodeUnitDescription(harmonizedTariffScheduleCodeUnit, getPreferredLanguage());
120        var harmonizedTariffScheduleCodeUnitDetail = harmonizedTariffScheduleCodeUnit.getLastDetail();
121
122        edit.setHarmonizedTariffScheduleCodeUnitName(harmonizedTariffScheduleCodeUnitDetail.getHarmonizedTariffScheduleCodeUnitName());
123        edit.setIsDefault(harmonizedTariffScheduleCodeUnitDetail.getIsDefault().toString());
124        edit.setSortOrder(harmonizedTariffScheduleCodeUnitDetail.getSortOrder().toString());
125
126        if(harmonizedTariffScheduleCodeUnitDescription != null) {
127            edit.setDescription(harmonizedTariffScheduleCodeUnitDescription.getDescription());
128        }
129    }
130
131    @Override
132    public void canUpdate(HarmonizedTariffScheduleCodeUnit harmonizedTariffScheduleCodeUnit) {
133        var harmonizedTariffScheduleCodeUnitName = edit.getHarmonizedTariffScheduleCodeUnitName();
134        var duplicateHarmonizedTariffScheduleCodeUnit = itemControl.getHarmonizedTariffScheduleCodeUnitByName(harmonizedTariffScheduleCodeUnitName);
135
136        if(duplicateHarmonizedTariffScheduleCodeUnit != null && !harmonizedTariffScheduleCodeUnit.equals(duplicateHarmonizedTariffScheduleCodeUnit)) {
137            addExecutionError(ExecutionErrors.DuplicateHarmonizedTariffScheduleCodeUnitName.name(), harmonizedTariffScheduleCodeUnitName);
138        }
139    }
140
141    @Override
142    public void doUpdate(HarmonizedTariffScheduleCodeUnit harmonizedTariffScheduleCodeUnit) {
143        var partyPK = getPartyPK();
144        var harmonizedTariffScheduleCodeUnitDetailValue = itemControl.getHarmonizedTariffScheduleCodeUnitDetailValueForUpdate(harmonizedTariffScheduleCodeUnit);
145        var harmonizedTariffScheduleCodeUnitDescription = itemControl.getHarmonizedTariffScheduleCodeUnitDescriptionForUpdate(harmonizedTariffScheduleCodeUnit, getPreferredLanguage());
146        var description = edit.getDescription();
147
148        harmonizedTariffScheduleCodeUnitDetailValue.setHarmonizedTariffScheduleCodeUnitName(edit.getHarmonizedTariffScheduleCodeUnitName());
149        harmonizedTariffScheduleCodeUnitDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
150        harmonizedTariffScheduleCodeUnitDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
151
152        itemControl.updateHarmonizedTariffScheduleCodeUnitFromValue(harmonizedTariffScheduleCodeUnitDetailValue, partyPK);
153
154        if(harmonizedTariffScheduleCodeUnitDescription == null && description != null) {
155            itemControl.createHarmonizedTariffScheduleCodeUnitDescription(harmonizedTariffScheduleCodeUnit, getPreferredLanguage(), description, partyPK);
156        } else if(harmonizedTariffScheduleCodeUnitDescription != null && description == null) {
157            itemControl.deleteHarmonizedTariffScheduleCodeUnitDescription(harmonizedTariffScheduleCodeUnitDescription, partyPK);
158        } else if(harmonizedTariffScheduleCodeUnitDescription != null && description != null) {
159            var harmonizedTariffScheduleCodeUnitDescriptionValue = itemControl.getHarmonizedTariffScheduleCodeUnitDescriptionValue(harmonizedTariffScheduleCodeUnitDescription);
160
161            harmonizedTariffScheduleCodeUnitDescriptionValue.setDescription(description);
162            itemControl.updateHarmonizedTariffScheduleCodeUnitDescriptionFromValue(harmonizedTariffScheduleCodeUnitDescriptionValue, partyPK);
163        }
164    }
165
166}