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.ItemAliasEdit;
020import com.echothree.control.user.item.common.edit.ItemEditFactory;
021import com.echothree.control.user.item.common.form.EditItemAliasForm;
022import com.echothree.control.user.item.common.result.EditItemAliasResult;
023import com.echothree.control.user.item.common.result.ItemResultFactory;
024import com.echothree.control.user.item.common.spec.ItemAliasSpec;
025import com.echothree.model.control.item.server.control.ItemControl;
026import com.echothree.model.control.item.server.logic.ItemAliasChecksumTypeLogic;
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.control.uom.server.control.UomControl;
031import com.echothree.model.control.vendor.server.control.VendorControl;
032import com.echothree.model.data.item.server.entity.Item;
033import com.echothree.model.data.item.server.entity.ItemAlias;
034import com.echothree.model.data.item.server.entity.ItemAliasType;
035import com.echothree.model.data.item.server.entity.ItemAliasTypeDetail;
036import com.echothree.model.data.item.server.entity.ItemDetail;
037import com.echothree.model.data.item.server.value.ItemAliasValue;
038import com.echothree.model.data.party.server.entity.Party;
039import com.echothree.model.data.uom.server.entity.UnitOfMeasureKind;
040import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
041import com.echothree.model.data.user.common.pk.UserVisitPK;
042import com.echothree.model.data.vendor.server.entity.Vendor;
043import com.echothree.model.data.vendor.server.entity.VendorItem;
044import com.echothree.model.data.vendor.server.value.VendorItemDetailValue;
045import com.echothree.util.common.message.ExecutionErrors;
046import com.echothree.util.common.validation.FieldDefinition;
047import com.echothree.util.common.validation.FieldType;
048import com.echothree.util.common.persistence.BasePK;
049import com.echothree.util.server.control.BaseAbstractEditCommand;
050import com.echothree.util.server.control.CommandSecurityDefinition;
051import com.echothree.util.server.control.PartyTypeDefinition;
052import com.echothree.util.server.control.SecurityRoleDefinition;
053import com.echothree.util.server.persistence.Session;
054import java.util.Arrays;
055import java.util.Collections;
056import java.util.List;
057import java.util.regex.Matcher;
058import java.util.regex.Pattern;
059
060public class EditItemAliasCommand
061        extends BaseAbstractEditCommand<ItemAliasSpec, ItemAliasEdit, EditItemAliasResult, ItemAlias, Item> {
062
063    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
064    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
065    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
066    
067    static {
068        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
069                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
070                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
071                        new SecurityRoleDefinition(SecurityRoleGroups.ItemAlias.name(), SecurityRoles.Edit.name())
072                )))
073        )));
074
075        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
076                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
077                ));
078        
079        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
080                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, true, null, null),
081                new FieldDefinition("ItemAliasTypeName", FieldType.ENTITY_NAME, true, null, null),
082                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
083                ));
084    }
085    
086    /** Creates a new instance of EditItemAliasCommand */
087    public EditItemAliasCommand(UserVisitPK userVisitPK, EditItemAliasForm form) {
088        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
089    }
090    
091    @Override
092    public EditItemAliasResult getResult() {
093        return ItemResultFactory.getEditItemAliasResult();
094    }
095
096    @Override
097    public ItemAliasEdit getEdit() {
098        return ItemEditFactory.getItemAliasEdit();
099    }
100
101    @Override
102    public ItemAlias getEntity(EditItemAliasResult result) {
103        var itemControl = Session.getModelController(ItemControl.class);
104        String alias = spec.getAlias();
105        ItemAlias itemAlias = itemControl.getItemAliasByAliasForUpdate(alias);
106
107        if(itemAlias == null) {
108            addExecutionError(ExecutionErrors.UnknownItemAlias.name(), alias);
109        }
110
111        return itemAlias;
112    }
113
114    @Override
115    public Item getLockEntity(ItemAlias itemAlias) {
116        return itemAlias.getItem();
117    }
118
119    @Override
120    public void fillInResult(EditItemAliasResult result, ItemAlias itemAlias) {
121        var itemControl = Session.getModelController(ItemControl.class);
122
123        result.setItemAlias(itemControl.getItemAliasTransfer(getUserVisit(), itemAlias));
124    }
125
126    @Override
127    public void doLock(ItemAliasEdit edit, ItemAlias itemAlias) {
128        edit.setUnitOfMeasureTypeName(itemAlias.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName());
129        edit.setItemAliasTypeName(itemAlias.getItemAliasType().getLastDetail().getItemAliasTypeName());
130        edit.setAlias(itemAlias.getAlias());
131    }
132
133    UnitOfMeasureType unitOfMeasureType;
134    ItemAliasType itemAliasType;
135
136    @Override
137    public void canUpdate(ItemAlias itemAlias) {
138        var itemControl = Session.getModelController(ItemControl.class);
139        String alias = edit.getAlias();
140        Item duplicateItem = itemControl.getItemByName(alias);
141
142        if(duplicateItem == null) {
143            ItemAlias duplicateItemAlias = itemControl.getItemAliasByAlias(alias);
144
145            if(duplicateItemAlias == null || duplicateItemAlias.getPrimaryKey().equals(itemAlias.getPrimaryKey())) {
146                var uomControl = Session.getModelController(UomControl.class);
147                String unitOfMeasureTypeName = edit.getUnitOfMeasureTypeName();
148                ItemDetail itemDetail = itemAlias.getItem().getLastDetail();
149                UnitOfMeasureKind unitOfMeasureKind = itemDetail.getUnitOfMeasureKind();
150
151                unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(unitOfMeasureKind, unitOfMeasureTypeName);
152
153                if(unitOfMeasureType != null) {
154                    String itemAliasTypeName = edit.getItemAliasTypeName();
155
156                    itemAliasType = itemControl.getItemAliasTypeByName(itemAliasTypeName);
157
158                    if(itemAliasType != null) {
159                        ItemAliasTypeDetail itemAliasTypeDetail = itemAliasType.getLastDetail();
160                        String validationPattern = itemAliasTypeDetail.getValidationPattern();
161
162                        if(validationPattern != null) {
163                            Pattern pattern = Pattern.compile(validationPattern);
164                            Matcher m = pattern.matcher(alias);
165
166                            if(!m.matches()) {
167                                addExecutionError(ExecutionErrors.InvalidAlias.name(), alias);
168                            }
169                        }
170
171                        if(!hasExecutionErrors()) {
172                            ItemAliasChecksumTypeLogic.getInstance().checkItemAliasChecksum(this, itemAliasType, alias);
173                        }
174                    } else {
175                        addExecutionError(ExecutionErrors.UnknownItemAliasType.name(), itemAliasTypeName);
176                    }
177                } else {
178                    addExecutionError(ExecutionErrors.UnknownUnitOfMeasureTypeName.name(), unitOfMeasureTypeName);
179                }
180            } else {
181                addExecutionError(ExecutionErrors.DuplicateItemAlias.name(), itemAlias.getItem().getLastDetail().getItemName(),
182                        itemAlias.getUnitOfMeasureType().getLastDetail().getUnitOfMeasureTypeName(), itemAlias.getAlias());
183            }
184        } else {
185            addExecutionError(ExecutionErrors.AliasDuplicatesItemName.name(), duplicateItem.getLastDetail().getItemName());
186        }
187    }
188
189    @Override
190    public void doUpdate(ItemAlias itemAlias) {
191        var itemControl = Session.getModelController(ItemControl.class);
192        ItemAliasValue itemAliasValue = itemControl.getItemAliasValue(itemAlias);
193        String alias = edit.getAlias();
194        String originalAlias = itemAliasValue.getAlias();
195        BasePK updatedBy = getPartyPK();
196
197        itemAliasValue.setUnitOfMeasureTypePK(unitOfMeasureType.getPrimaryKey());
198        itemAliasValue.setItemAliasTypePK(itemAliasType.getPrimaryKey());
199        itemAliasValue.setAlias(alias);
200
201        itemControl.updateItemAliasFromValue(itemAliasValue, updatedBy);
202
203        if(itemAliasValue.getAliasHasBeenModified()) {
204            var vendorControl = Session.getModelController(VendorControl.class);
205            List<Vendor> vendors = vendorControl.getVendorsByDefaultItemAliasType(itemAliasType);
206
207            for(var vendor : vendors) {
208                Party vendorParty = vendor.getParty();
209                VendorItem vendorItem = vendorControl.getVendorItemByVendorPartyAndVendorItemNameForUpdate(vendorParty, originalAlias);
210
211                if(vendorItem != null) {
212                    try {
213                        if(lockEntity(vendorItem) && lockEntityForUpdate(vendorItem)) {
214                            VendorItem duplicateVendorItem = vendorControl.getVendorItemByVendorPartyAndVendorItemName(vendorParty, alias);
215
216                            if(duplicateVendorItem == null) {
217                                VendorItemDetailValue vendorItemDetailValue = vendorControl.getVendorItemDetailValueForUpdate(vendorItem);
218
219                                vendorItemDetailValue.setVendorItemName(alias);
220
221                                vendorControl.updateVendorItemFromValue(vendorItemDetailValue, updatedBy);
222                            }
223                        }
224                    } finally {
225                        unlockEntity(vendorItem);
226                    }
227                }
228            }
229        }
230    }
231
232}