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.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.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.inventory.server.entity.Lot;
031import com.echothree.model.data.inventory.server.entity.LotAlias;
032import com.echothree.model.data.inventory.server.entity.LotAliasType;
033import com.echothree.model.data.inventory.server.entity.LotAliasTypeDetail;
034import com.echothree.model.data.inventory.server.value.LotAliasValue;
035import com.echothree.model.data.user.common.pk.UserVisitPK;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.server.control.BaseAbstractEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048
049public class EditLotAliasCommand
050        extends BaseAbstractEditCommand<LotAliasSpec, LotAliasEdit, EditLotAliasResult, LotAlias, LotAlias> {
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(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(SecurityRoleGroups.LotAliasType.name(), SecurityRoles.Edit.name())
061                )))
062        )));
063
064        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("LotName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("LotAliasTypeName", FieldType.ENTITY_NAME, true, null, null)
067                ));
068        
069        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
071                ));
072    }
073    
074    /** Creates a new instance of EditLotAliasCommand */
075    public EditLotAliasCommand(UserVisitPK userVisitPK, EditLotAliasForm form) {
076        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    public EditLotAliasResult getResult() {
081        return InventoryResultFactory.getEditLotAliasResult();
082    }
083
084    @Override
085    public LotAliasEdit getEdit() {
086        return InventoryEditFactory.getLotAliasEdit();
087    }
088
089    LotAliasType lotAliasType;
090    
091    @Override
092    public LotAlias getEntity(EditLotAliasResult result) {
093        var lotControl = Session.getModelController(LotControl.class);
094        LotAlias lotAlias = null;
095        String lotName = spec.getLotName();
096        Lot lot = lotControl.getLotByName(lotName);
097
098        if(lot != null) {
099            var lotAliasControl = Session.getModelController(LotAliasControl.class);
100            String lotAliasTypeName = spec.getLotAliasTypeName();
101
102            lotAliasType = lotAliasControl.getLotAliasTypeByName(lotAliasTypeName);
103
104            if(lotAliasType != null) {
105                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
106                    lotAlias = lotAliasControl.getLotAlias(lot, lotAliasType);
107                } else { // EditMode.UPDATE
108                    lotAlias = lotAliasControl.getLotAliasForUpdate(lot, lotAliasType);
109                }
110
111                if(lotAlias != null) {
112                    result.setLotAlias(lotAliasControl.getLotAliasTransfer(getUserVisit(), lotAlias));
113                } else {
114                    addExecutionError(ExecutionErrors.UnknownLotAlias.name(), lotName, lotAliasTypeName);
115                }
116            } else {
117                addExecutionError(ExecutionErrors.UnknownLotAliasTypeName.name(), lotAliasTypeName);
118            }
119        } else {
120            addExecutionError(ExecutionErrors.UnknownLotName.name(), lotName);
121        }
122
123        return lotAlias;
124    }
125
126    @Override
127    public LotAlias getLockEntity(LotAlias lotAlias) {
128        return lotAlias;
129    }
130
131    @Override
132    public void fillInResult(EditLotAliasResult result, LotAlias lotAlias) {
133        var lotAliasControl = Session.getModelController(LotAliasControl.class);
134
135        result.setLotAlias(lotAliasControl.getLotAliasTransfer(getUserVisit(), lotAlias));
136    }
137
138    @Override
139    public void doLock(LotAliasEdit edit, LotAlias lotAlias) {
140        edit.setAlias(lotAlias.getAlias());
141    }
142
143    @Override
144    public void canUpdate(LotAlias lotAlias) {
145        var lotAliasControl = Session.getModelController(LotAliasControl.class);
146        String alias = edit.getAlias();
147        LotAlias duplicateLotAlias = lotAliasControl.getLotAliasByAlias(lotAliasType, alias);
148
149        if(duplicateLotAlias != null && !lotAlias.equals(duplicateLotAlias)) {
150            LotAliasTypeDetail lotAliasTypeDetail = lotAlias.getLotAliasType().getLastDetail();
151
152            addExecutionError(ExecutionErrors.DuplicateLotAlias.name(), lotAliasTypeDetail.getLotAliasTypeName(), alias);
153        }
154    }
155
156    @Override
157    public void doUpdate(LotAlias lotAlias) {
158        var lotAliasControl = Session.getModelController(LotAliasControl.class);
159        LotAliasValue lotAliasValue = lotAliasControl.getLotAliasValue(lotAlias);
160
161        lotAliasValue.setAlias(edit.getAlias());
162
163        lotAliasControl.updateLotAliasFromValue(lotAliasValue, getPartyPK());
164    }
165
166}