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.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.HarmonizedTariffScheduleCodeUse;
033import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeUseType;
034import com.echothree.model.data.item.server.entity.Item;
035import com.echothree.model.data.item.server.entity.ItemHarmonizedTariffScheduleCode;
036import com.echothree.model.data.item.server.entity.ItemHarmonizedTariffScheduleCodeDetail;
037import com.echothree.model.data.item.server.value.ItemHarmonizedTariffScheduleCodeDetailValue;
038import com.echothree.model.data.user.common.pk.UserVisitPK;
039import com.echothree.util.common.message.ExecutionErrors;
040import com.echothree.util.common.validation.FieldDefinition;
041import com.echothree.util.common.validation.FieldType;
042import com.echothree.util.common.command.EditMode;
043import com.echothree.util.server.control.BaseAbstractEditCommand;
044import com.echothree.util.server.control.CommandSecurityDefinition;
045import com.echothree.util.server.control.PartyTypeDefinition;
046import com.echothree.util.server.control.SecurityRoleDefinition;
047import com.echothree.util.server.persistence.Session;
048import java.util.Arrays;
049import java.util.Collections;
050import java.util.List;
051
052public class EditItemHarmonizedTariffScheduleCodeCommand
053        extends BaseAbstractEditCommand<ItemHarmonizedTariffScheduleCodeSpec, ItemHarmonizedTariffScheduleCodeEdit, EditItemHarmonizedTariffScheduleCodeResult, ItemHarmonizedTariffScheduleCode, ItemHarmonizedTariffScheduleCode> {
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.ItemHarmonizedTariffScheduleCode.name(), SecurityRoles.Edit.name())
064                        )))
065                )));
066
067        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("HarmonizedTariffScheduleCodeUseTypeName", FieldType.ENTITY_NAME, true, null, null)
071                ));
072
073        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
074                new FieldDefinition("HarmonizedTariffScheduleCodeName", FieldType.ENTITY_NAME, true, null, null)
075                ));
076    }
077
078    /** Creates a new instance of EditItemHarmonizedTariffScheduleCodeCommand */
079    public EditItemHarmonizedTariffScheduleCodeCommand(UserVisitPK userVisitPK, EditItemHarmonizedTariffScheduleCodeForm form) {
080        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082
083    @Override
084    public EditItemHarmonizedTariffScheduleCodeResult getResult() {
085        return ItemResultFactory.getEditItemHarmonizedTariffScheduleCodeResult();
086    }
087
088    @Override
089    public ItemHarmonizedTariffScheduleCodeEdit getEdit() {
090        return ItemEditFactory.getItemHarmonizedTariffScheduleCodeEdit();
091    }
092
093    GeoCode countryGeoCode;
094    HarmonizedTariffScheduleCodeUseType harmonizedTariffScheduleCodeUseType;
095
096    @Override
097    public ItemHarmonizedTariffScheduleCode getEntity(EditItemHarmonizedTariffScheduleCodeResult result) {
098        var itemControl = Session.getModelController(ItemControl.class);
099        ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode = null;
100        String itemName = spec.getItemName();
101        Item item = itemControl.getItemByName(itemName);
102        
103        if(item != null) {
104            var geoControl = Session.getModelController(GeoControl.class);
105            String countryName = spec.getCountryName();
106            
107            countryGeoCode = geoControl.getCountryByAlias(countryName);
108            
109            if(countryGeoCode != null) {
110                String 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        var itemControl = Session.getModelController(ItemControl.class);
147
148        result.setItemHarmonizedTariffScheduleCode(itemControl.getItemHarmonizedTariffScheduleCodeTransfer(getUserVisit(), itemHarmonizedTariffScheduleCode));
149    }
150
151    @Override
152    public void doLock(ItemHarmonizedTariffScheduleCodeEdit edit, ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode) {
153        ItemHarmonizedTariffScheduleCodeDetail itemHarmonizedTariffScheduleCodeDetail = itemHarmonizedTariffScheduleCode.getLastDetail();
154        
155        edit.setHarmonizedTariffScheduleCodeName(itemHarmonizedTariffScheduleCodeDetail.getHarmonizedTariffScheduleCode().getLastDetail().getHarmonizedTariffScheduleCodeName());
156    }
157
158    HarmonizedTariffScheduleCode harmonizedTariffScheduleCode;
159    
160    @Override
161    public void canUpdate(ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode) {
162        var itemControl = Session.getModelController(ItemControl.class);
163        String harmonizedTariffScheduleCodeName = edit.getHarmonizedTariffScheduleCodeName();
164        
165        harmonizedTariffScheduleCode = itemControl.getHarmonizedTariffScheduleCodeByName(countryGeoCode, harmonizedTariffScheduleCodeName);
166
167        if(harmonizedTariffScheduleCode != null) {
168            HarmonizedTariffScheduleCodeUse harmonizedTariffScheduleCodeUse = itemControl.getHarmonizedTariffScheduleCodeUse(harmonizedTariffScheduleCode,
169                    harmonizedTariffScheduleCodeUseType);
170
171            if(harmonizedTariffScheduleCodeUse == null) {
172                addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeUse.name(), spec.getCountryName(), harmonizedTariffScheduleCodeName,
173                        spec.getHarmonizedTariffScheduleCodeUseTypeName());
174            }
175        } else {
176            addExecutionError(ExecutionErrors.UnknownHarmonizedTariffScheduleCodeName.name(), spec.getCountryName(), harmonizedTariffScheduleCodeName);
177        }
178    }
179
180    @Override
181    public void doUpdate(ItemHarmonizedTariffScheduleCode itemHarmonizedTariffScheduleCode) {
182        var itemControl = Session.getModelController(ItemControl.class);
183        ItemHarmonizedTariffScheduleCodeDetailValue itemHarmonizedTariffScheduleCodeDetailValue = itemControl.getItemHarmonizedTariffScheduleCodeDetailValueForUpdate(itemHarmonizedTariffScheduleCode);
184        
185        itemHarmonizedTariffScheduleCodeDetailValue.setHarmonizedTariffScheduleCodePK(harmonizedTariffScheduleCode.getPrimaryKey());
186        
187        itemControl.updateItemHarmonizedTariffScheduleCodeFromValue(itemHarmonizedTariffScheduleCodeDetailValue, getPartyPK());
188    }
189
190}