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.GetInventoryLocationGroupDescriptionsForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.InventoryControl;
022import com.echothree.model.control.warehouse.server.control.WarehouseControl;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.persistence.Session;
030import java.util.Arrays;
031import java.util.Collections;
032import java.util.List;
033import javax.enterprise.context.RequestScoped;
034
035@RequestScoped
036public class GetInventoryLocationGroupDescriptionsCommand
037        extends BaseSimpleCommand<GetInventoryLocationGroupDescriptionsForm> {
038    
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
043                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
044                new FieldDefinition("InventoryLocationGroupName", FieldType.ENTITY_NAME, true, null, null)
045                ));
046    }
047    
048    /** Creates a new instance of GetInventoryLocationGroupDescriptionsCommand */
049    public GetInventoryLocationGroupDescriptionsCommand() {
050        super(null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected BaseResult execute() {
055        var warehouseControl = Session.getModelController(WarehouseControl.class);
056        var result = InventoryResultFactory.getGetInventoryLocationGroupDescriptionsResult();
057        var warehouseName = form.getWarehouseName();
058        var warehouse = warehouseControl.getWarehouseByName(warehouseName);
059        
060        if(warehouse != null) {
061            var inventoryControl = Session.getModelController(InventoryControl.class);
062            var warehouseParty = warehouse.getParty();
063            var inventoryLocationGroupName = form.getInventoryLocationGroupName();
064            var inventoryLocationGroup = inventoryControl.getInventoryLocationGroupByName(warehouseParty, inventoryLocationGroupName);
065            
066            result.setWarehouse(warehouseControl.getWarehouseTransfer(getUserVisit(), warehouse));
067            
068            if(inventoryLocationGroup != null) {
069                result.setInventoryLocationGroup(inventoryControl.getInventoryLocationGroupTransfer(getUserVisit(), inventoryLocationGroup));
070                result.setInventoryLocationGroupDescriptions(inventoryControl.getInventoryLocationGroupDescriptionTransfersByInventoryLocationGroup(getUserVisit(), inventoryLocationGroup));
071            } else {
072                addExecutionError(ExecutionErrors.UnknownInventoryLocationGroupName.name(), inventoryLocationGroupName);
073            }
074        } else {
075            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
076        }
077        
078        return result;
079    }
080    
081}