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.GetInventoryLocationGroupForm;
020import com.echothree.control.user.inventory.common.result.GetInventoryLocationGroupResult;
021import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.inventory.server.control.InventoryControl;
024import com.echothree.model.control.warehouse.server.control.WarehouseControl;
025import com.echothree.model.data.inventory.server.entity.InventoryLocationGroup;
026import com.echothree.model.data.party.server.entity.Party;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.model.data.warehouse.server.entity.Warehouse;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038
039public class GetInventoryLocationGroupCommand
040        extends BaseSimpleCommand<GetInventoryLocationGroupForm> {
041    
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
046            new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
047            new FieldDefinition("InventoryLocationGroupName", FieldType.ENTITY_NAME, true, null, null)
048        ));
049    }
050    
051    /** Creates a new instance of GetInventoryLocationGroupCommand */
052    public GetInventoryLocationGroupCommand(UserVisitPK userVisitPK, GetInventoryLocationGroupForm form) {
053        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
054    }
055    
056    @Override
057    protected BaseResult execute() {
058        var warehouseControl = Session.getModelController(WarehouseControl.class);
059        GetInventoryLocationGroupResult result = InventoryResultFactory.getGetInventoryLocationGroupResult();
060        String warehouseName = form.getWarehouseName();
061        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
062        
063        if(warehouse != null) {
064            var inventoryControl = Session.getModelController(InventoryControl.class);
065            Party warehouseParty = warehouse.getParty();
066            String inventoryLocationGroupName = form.getInventoryLocationGroupName();
067            InventoryLocationGroup inventoryLocationGroup = inventoryControl.getInventoryLocationGroupByName(warehouseParty, inventoryLocationGroupName);
068            
069            if(inventoryLocationGroup != null) {
070                result.setInventoryLocationGroup(inventoryControl.getInventoryLocationGroupTransfer(getUserVisit(), inventoryLocationGroup));
071                
072                sendEvent(inventoryLocationGroup.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
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}