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