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.GetInventoryLocationForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.InventoryLocationControl;
022import com.echothree.model.control.inventory.server.logic.InventoryLocationLogic;
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.control.warehouse.server.logic.LocationLogic;
028import com.echothree.model.data.inventory.server.entity.InventoryLocation;
029import com.echothree.util.common.command.BaseResult;
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 GetInventoryLocationCommand
042        extends BaseSingleEntityCommand<InventoryLocation, GetInventoryLocationForm> {
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.InventoryLocation.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    InventoryLocationControl inventoryLocationControl;
065
066    @Inject
067    InventoryLocationLogic inventoryLocationLogic;
068
069    @Inject
070    LocationLogic locationLogic;
071
072    @Inject
073    ItemLogic itemLogic;
074
075    /** Creates a new instance of GetInventoryLocationCommand */
076    public GetInventoryLocationCommand() {
077        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
078    }
079
080    @Override
081    protected InventoryLocation getEntity() {
082        var location = locationLogic.getLocation(this, form);
083        InventoryLocation inventoryLocation = null;
084
085        if(!hasExecutionErrors()) {
086            var item = itemLogic.getItemByName(this, form.getItemName());
087
088            if(!hasExecutionErrors()) {
089                inventoryLocation = inventoryLocationLogic.getInventoryLocation(this, location, item);
090            }
091        }
092
093        return inventoryLocation;
094    }
095
096    @Override
097    protected BaseResult getResult(InventoryLocation inventoryLocation) {
098        var result = InventoryResultFactory.getGetInventoryLocationResult();
099
100        if(inventoryLocation != null) {
101            result.setInventoryLocation(inventoryLocationControl.getInventoryLocationTransfer(getUserVisit(), inventoryLocation));
102        }
103
104        return result;
105    }
106
107}