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.GetInventoryLocationGroupDescriptionsForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.InventoryLocationGroupControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.warehouse.server.control.WarehouseControl;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
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.inject.Inject;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetInventoryLocationGroupDescriptionsCommand
041        extends BaseSimpleCommand<GetInventoryLocationGroupDescriptionsForm> {
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.InventoryLocationGroup.name(), SecurityRoles.Description.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("InventoryLocationGroupName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059
060    @Inject
061    InventoryLocationGroupControl inventoryLocationGroupControl;
062
063    @Inject
064    WarehouseControl warehouseControl;
065
066    /** Creates a new instance of GetInventoryLocationGroupDescriptionsCommand */
067    public GetInventoryLocationGroupDescriptionsCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070
071    @Override
072    protected BaseResult execute() {
073        var result = InventoryResultFactory.getGetInventoryLocationGroupDescriptionsResult();
074        var warehouseName = form.getWarehouseName();
075        var warehouse = warehouseControl.getWarehouseByName(warehouseName);
076
077        if(warehouse != null) {
078            var warehouseParty = warehouse.getParty();
079            var inventoryLocationGroupName = form.getInventoryLocationGroupName();
080            var inventoryLocationGroup = inventoryLocationGroupControl.getInventoryLocationGroupByName(warehouseParty, inventoryLocationGroupName);
081
082            result.setWarehouse(warehouseControl.getWarehouseTransfer(getUserVisit(), warehouse));
083
084            if(inventoryLocationGroup != null) {
085                result.setInventoryLocationGroup(inventoryLocationGroupControl.getInventoryLocationGroupTransfer(getUserVisit(), inventoryLocationGroup));
086                result.setInventoryLocationGroupDescriptions(inventoryLocationGroupControl.getInventoryLocationGroupDescriptionTransfersByInventoryLocationGroup(getUserVisit(), inventoryLocationGroup));
087            } else {
088                addExecutionError(ExecutionErrors.UnknownInventoryLocationGroupName.name(), inventoryLocationGroupName);
089            }
090        } else {
091            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
092        }
093
094        return result;
095    }
096
097}