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.ItemEditFactory;
020import com.echothree.control.user.item.common.edit.ItemHarmonizedTariffScheduleCodeEdit;
021import com.echothree.control.user.item.common.form.EditItemHarmonizedTariffScheduleCodeForm;
022import com.echothree.control.user.item.common.result.EditItemHarmonizedTariffScheduleCodeResult;
023import com.echothree.control.user.item.common.result.ItemResultFactory;
024import com.echothree.control.user.item.common.spec.ItemHarmonizedTariffScheduleCodeSpec;
025import com.echothree.model.control.geo.server.control.GeoControl;
026import com.echothree.model.control.item.server.control.ItemControl;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.geo.server.entity.GeoCode;
031import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCode;
032import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeUseType;
033import com.echothree.model.data.item.server.entity.ItemHarmonizedTariffScheduleCode;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import java.util.List;
044import javax.enterprise.context.Dependent;
045import javax.inject.Inject;
046
047@Dependent
048public class EditItemHarmonizedTariffScheduleCodeCommand
049        extends BaseAbstractEditCommand<ItemHarmonizedTariffScheduleCodeSpec, ItemHarmonizedTariffScheduleCodeEdit, EditItemHarmonizedTariffScheduleCodeResult, ItemHarmonizedTariffScheduleCode, ItemHarmonizedTariffScheduleCode> {
050
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
059                        new SecurityRoleDefinition(SecurityRoleGroups.ItemHarmonizedTariffScheduleCode.name(), SecurityRoles.Edit.name())
060                ))
061        ));
062
063        SPEC_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("HarmonizedTariffScheduleCodeUseTypeName", FieldType.ENTITY_NAME, true, null, null)
067        );
068
069        EDIT_FIELD_DEFINITIONS = List.of(
070                new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.ENTITY_NAME, true, null, null)
071        );
072    }
073
074    @Inject
075    GeoControl geoControl;
076
077    @Inject
078    ItemControl itemControl;
079
080    /** Creates a new instance of EditItemHarmonizedTariffScheduleCodeCommand */
081    public EditItemHarmonizedTariffScheduleCodeCommand() {
082        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084
085    @Override
086    public EditItemHarmonizedTariffScheduleCodeResult getResult() {
087        return ItemResultFactory.getEditItemHarmonizedTariffScheduleCodeResult();
088    }
089
090    @Override
091    public ItemHarmonizedTariffScheduleCodeEdit getEdit() {
092        return ItemEditFactory.getItemHarmonizedTariffScheduleCodeEdit();
093    }
094
095    GeoCode countryGeoCode;
096    HarmonizedTariffScheduleCodeUseType harmonizedTariffScheduleCodeUseType;
097
098    @Override
099    public ItemHarmonizedTariffScheduleCode getEntity(EditItemHarmonizedTariffScheduleCodeResult result) {
100        ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode = null;
101        var itemName = spec.getItemName();
102        var item = itemControl.getItemByName(itemName);
103        
104        if(item != null) {
105            var countryName = spec.getCountryName();
106            
107            countryGeoCode = geoControl.getCountryByAlias(countryName);
108            
109            if(countryGeoCode != null) {
110                var harmonizedTariffScheduleCodeUseTypeName = spec.getHarmonizedTariffScheduleCodeUseTypeName();
111                
112                harmonizedTariffScheduleCodeUseType = itemControl.getHarmonizedTariffScheduleCodeUseTypeByName(harmonizedTariffScheduleCodeUseTypeName);
113
114                if(harmonizedTariffScheduleCodeUseType != null) {
115                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
116                        itemHarmonizedTariffScheduleCode = itemControl.getItemHarmonizedTariffScheduleCode(item,
117                                countryGeoCode, harmonizedTariffScheduleCodeUseType);
118                    } else { // EditMode.UPDATE
119                        itemHarmonizedTariffScheduleCode = itemControl.getItemHarmonizedTariffScheduleCodeForUpdate(item, countryGeoCode,
120                                harmonizedTariffScheduleCodeUseType);
121                    }
122
123                    if(itemHarmonizedTariffScheduleCode == null) {
124                        addExecutionError(ExecutionErrors.UnknownItemHarmonizedTariffScheduleCode.name(), itemName, countryName, harmonizedTariffScheduleCodeUseTypeName);
125                    }
126                } else {
127                    addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUseTypeName.name(), harmonizedTariffScheduleCodeUseTypeName);
128                }
129            } else {
130                addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
131            }
132        } else {
133            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
134        }
135
136        return itemHarmonizedTariffScheduleCode;
137    }
138
139    @Override
140    public ItemHarmonizedTariffScheduleCode getLockEntity(ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode) {
141        return itemHarmonizedTariffScheduleCode;
142    }
143
144    @Override
145    public void fillInResult(EditItemHarmonizedTariffScheduleCodeResult result, ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode) {
146        result.setItemHarmonizedTariffScheduleCode(itemControl.getItemHarmonizedTariffScheduleCodeTransfer(getUserVisit(), itemHarmonizedTariffScheduleCode));
147    }
148
149    @Override
150    public void doLock(ItemHarmonizedTariffScheduleCodeEdit edit, ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode) {
151        var itemHarmonizedTariffScheduleCodeDetail = itemHarmonizedTariffScheduleCode.getLastDetail();
152        
153        edit.setHarmonizedTariffScheduleCodeName(itemHarmonizedTariffScheduleCodeDetail.getHarmonizedTariffScheduleCode().getLastDetail().getHarmonizedTariffScheduleCodeName());
154    }
155
156    HarmonizedTariffScheduleCode harmonizedTariffScheduleCode;
157    
158    @Override
159    public void canUpdate(ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode) {
160        var harmonizedTariffScheduleCodeName = edit.getHarmonizedTariffScheduleCodeName();
161        
162        harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(countryGeoCode, harmonizedTariffScheduleCodeName);
163
164        if(harmonizedTariffScheduleCode != null) {
165            var harmonizedTariffScheduleCodeUse = itemControl.getHarmonizedTariffScheduleCodeUse(harmonizedTariffScheduleCode,
166                    harmonizedTariffScheduleCodeUseType);
167
168            if(harmonizedTariffScheduleCodeUse == null) {
169                addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUse.name(), spec.getCountryName(), harmonizedTariffScheduleCodeName,
170                        spec.getHarmonizedTariffScheduleCodeUseTypeName());
171            }
172        } else {
173            addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeName.name(), spec.getCountryName(), harmonizedTariffScheduleCodeName);
174        }
175    }
176
177    @Override
178    public void doUpdate(ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode) {
179        var itemHarmonizedTariffScheduleCodeDetailValue = itemControl.getItemHarmonizedTariffScheduleCodeDetailValueForUpdate(itemHarmonizedTariffScheduleCode);
180        
181        itemHarmonizedTariffScheduleCodeDetailValue.setHarmonizedTariffScheduleCodePK(harmonizedTariffScheduleCode.getPrimaryKey());
182        
183        itemControl.updateItemHarmonizedTariffScheduleCodeFromValue(itemHarmonizedTariffScheduleCodeDetailValue, getPartyPK());
184    }
185
186}