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