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