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