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