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.inventory.server.command;
018
019import com.echothree.control.user.inventory.common.edit.InventoryEditFactory;
020import com.echothree.control.user.inventory.common.edit.LotAliasEdit;
021import com.echothree.control.user.inventory.common.form.EditLotAliasForm;
022import com.echothree.control.user.inventory.common.result.EditLotAliasResult;
023import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
024import com.echothree.control.user.inventory.common.spec.LotAliasSpec;
025import com.echothree.model.control.inventory.server.control.LotAliasControl;
026import com.echothree.model.control.inventory.server.control.LotControl;
027import com.echothree.model.control.inventory.server.logic.LotLogic;
028import com.echothree.model.control.item.server.logic.ItemLogic;
029import com.echothree.model.control.party.common.PartyTypes;
030import com.echothree.model.control.security.common.SecurityRoleGroups;
031import com.echothree.model.control.security.common.SecurityRoles;
032import com.echothree.model.data.inventory.server.entity.LotAlias;
033import com.echothree.model.data.inventory.server.entity.LotAliasType;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.command.EditMode;
036import com.echothree.util.common.message.ExecutionErrors;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
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 javax.enterprise.context.RequestScoped;
048
049@RequestScoped
050public class EditLotAliasCommand
051        extends BaseAbstractEditCommand<LotAliasSpec, LotAliasEdit, EditLotAliasResult, LotAlias, LotAlias> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056    
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
061                        new SecurityRoleDefinition(SecurityRoleGroups.LotAliasType.name(), SecurityRoles.Edit.name())
062                )))
063        )));
064
065        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("LotIdentifier", FieldType.STRING, true, 1L, 40L),
068                new FieldDefinition("LotAliasTypeName", FieldType.ENTITY_NAME, true, null, null)
069                ));
070        
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
073                ));
074    }
075    
076    /** Creates a new instance of EditLotAliasCommand */
077    public EditLotAliasCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    public EditLotAliasResult getResult() {
083        return InventoryResultFactory.getEditLotAliasResult();
084    }
085
086    @Override
087    public LotAliasEdit getEdit() {
088        return InventoryEditFactory.getLotAliasEdit();
089    }
090
091    LotAliasType lotAliasType;
092    
093    @Override
094    public LotAlias getEntity(EditLotAliasResult result) {
095        LotAlias lotAlias = null;
096        var item = ItemLogic.getInstance().getItemByName(this, spec.getItemName());
097
098        if(!hasExecutionErrors()) {
099            var lotIdentifier = spec.getLotIdentifier();
100            var lot = LotLogic.getInstance().getLotByIdentifier(this, item, lotIdentifier);
101
102            if(!hasExecutionErrors()) {
103                var lotAliasControl = Session.getModelController(LotAliasControl.class);
104                var lotAliasTypeName = spec.getLotAliasTypeName();
105
106                lotAliasType = lotAliasControl.getLotAliasTypeByName(lotAliasTypeName);
107
108                if(lotAliasType != null) {
109                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
110                        lotAlias = lotAliasControl.getLotAlias(lot, lotAliasType);
111                    } else { // EditMode.UPDATE
112                        lotAlias = lotAliasControl.getLotAliasForUpdate(lot, lotAliasType);
113                    }
114
115                    if(lotAlias != null) {
116                        result.setLotAlias(lotAliasControl.getLotAliasTransfer(getUserVisit(), lotAlias));
117                    } else {
118                        addExecutionError(ExecutionErrors.UnknownLotAlias.name(), item.getLastDetail().getItemName(),
119                                lot.getLastDetail().getLotIdentifier(), lotAliasTypeName);
120                    }
121                } else {
122                    addExecutionError(ExecutionErrors.UnknownLotAliasTypeName.name(), lotAliasTypeName);
123                }
124            }
125        }
126
127        return lotAlias;
128    }
129
130    @Override
131    public LotAlias getLockEntity(LotAlias lotAlias) {
132        return lotAlias;
133    }
134
135    @Override
136    public void fillInResult(EditLotAliasResult result, LotAlias lotAlias) {
137        var lotAliasControl = Session.getModelController(LotAliasControl.class);
138
139        result.setLotAlias(lotAliasControl.getLotAliasTransfer(getUserVisit(), lotAlias));
140    }
141
142    @Override
143    public void doLock(LotAliasEdit edit, LotAlias lotAlias) {
144        edit.setAlias(lotAlias.getAlias());
145    }
146
147    @Override
148    public void canUpdate(LotAlias lotAlias) {
149        var lotAliasControl = Session.getModelController(LotAliasControl.class);
150        var alias = edit.getAlias();
151        var duplicateLotAlias = lotAliasControl.getLotAliasByAlias(lotAliasType, alias);
152
153        if(duplicateLotAlias != null && !lotAlias.equals(duplicateLotAlias)) {
154            var lotAliasTypeDetail = lotAlias.getLotAliasType().getLastDetail();
155
156            addExecutionError(ExecutionErrors.DuplicateLotAlias.name(), lotAliasTypeDetail.getLotAliasTypeName(), alias);
157        }
158    }
159
160    @Override
161    public void doUpdate(LotAlias lotAlias) {
162        var lotAliasControl = Session.getModelController(LotAliasControl.class);
163        var lotAliasValue = lotAliasControl.getLotAliasValue(lotAlias);
164
165        lotAliasValue.setAlias(edit.getAlias());
166
167        lotAliasControl.updateLotAliasFromValue(lotAliasValue, getPartyPK());
168    }
169
170}