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.GetInventoryLocationGroupsForm;
020import com.echothree.control.user.inventory.common.result.GetInventoryLocationGroupsResult;
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.party.server.entity.Party;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.model.data.warehouse.server.entity.Warehouse;
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.persistence.Session;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class GetInventoryLocationGroupsCommand
038        extends BaseSimpleCommand<GetInventoryLocationGroupsForm> {
039    
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
044                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null)
045                ));
046    }
047    
048    /** Creates a new instance of GetInventoryLocationGroupsCommand */
049    public GetInventoryLocationGroupsCommand(UserVisitPK userVisitPK, GetInventoryLocationGroupsForm form) {
050        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected BaseResult execute() {
055        var warehouseControl = Session.getModelController(WarehouseControl.class);
056        GetInventoryLocationGroupsResult result = InventoryResultFactory.getGetInventoryLocationGroupsResult();
057        String warehouseName = form.getWarehouseName();
058        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
059        
060        if(warehouse != null) {
061            var inventoryControl = Session.getModelController(InventoryControl.class);
062            Party warehouseParty = warehouse.getParty();
063            
064            result.setWarehouse(warehouseControl.getWarehouseTransfer(getUserVisit(), warehouse));
065            result.setInventoryLocationGroups(inventoryControl.getInventoryLocationGroupTransfersByWarehouseParty(getUserVisit(), warehouseParty));
066        } else {
067            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
068        }
069        
070        return result;
071    }
072    
073}