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