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.inventory.server.command;
018
019import com.echothree.control.user.inventory.common.form.GetLotAliasForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.LotAliasControl;
022import com.echothree.model.control.inventory.server.logic.LotLogic;
023import com.echothree.model.control.item.server.logic.ItemLogic;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.inventory.server.entity.LotAlias;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetLotAliasCommand
042        extends BaseSingleEntityCommand<LotAlias, GetLotAliasForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.LotAliasType.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LotIdentifier", FieldType.STRING, true, 1L, 40L),
058                new FieldDefinition("LotAliasTypeName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    LotAliasControl lotAliasControl;
064
065    @Inject
066    ItemLogic itemLogic;
067
068    @Inject
069    LotLogic lotLogic;
070
071    /** Creates a new instance of GetLotAliasCommand */
072    public GetLotAliasCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
074    }
075
076    @Override
077    protected LotAlias getEntity() {
078        LotAlias lotAlias = null;
079        var item = itemLogic.getItemByName(this, form.getItemName());
080
081        if(!hasExecutionErrors()) {
082            var lotIdentifier = form.getLotIdentifier();
083            var lot = lotLogic.getLotByIdentifier(this, item, lotIdentifier);
084
085            if(!hasExecutionErrors()) {
086                var lotAliasTypeName = form.getLotAliasTypeName();
087                var lotAliasType = lotAliasControl.getLotAliasTypeByName(lotAliasTypeName);
088
089                if(lotAliasType != null) {
090                    lotAlias = lotAliasControl.getLotAlias(lot, lotAliasType);
091
092                    if(lotAlias == null) {
093                        addExecutionError(ExecutionErrors.UnknownLotAlias.name(), item.getLastDetail().getItemName(),
094                                lot.getLastDetail().getLotIdentifier(), lotAliasType.getLastDetail().getLotAliasTypeName());
095                    }
096                } else {
097                    addExecutionError(ExecutionErrors.UnknownLotAliasTypeName.name(), lotAliasTypeName);
098                }
099            }
100        }
101
102        return lotAlias;
103    }
104
105    @Override
106    protected BaseResult getResult(LotAlias lotAlias) {
107        var result = InventoryResultFactory.getGetLotAliasResult();
108
109        if(lotAlias != null) {
110            result.setLotAlias(lotAliasControl.getLotAliasTransfer(getUserVisit(), lotAlias));
111        }
112
113        return result;
114    }
115
116}