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.GetInventoryLocationGroupStatusChoicesForm;
020import com.echothree.control.user.inventory.common.result.GetInventoryLocationGroupStatusChoicesResult;
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 GetInventoryLocationGroupStatusChoicesCommand
039        extends BaseSimpleCommand<GetInventoryLocationGroupStatusChoicesForm> {
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                new FieldDefinition("DefaultInventoryLocationGroupStatusChoice", FieldType.ENTITY_NAME, false, null, null)
048                ));
049    }
050    
051    /** Creates a new instance of GetInventoryLocationGroupStatusChoicesCommand */
052    public GetInventoryLocationGroupStatusChoicesCommand(UserVisitPK userVisitPK, GetInventoryLocationGroupStatusChoicesForm form) {
053        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
054    }
055    
056    @Override
057    protected BaseResult execute() {
058        GetInventoryLocationGroupStatusChoicesResult result = InventoryResultFactory.getGetInventoryLocationGroupStatusChoicesResult();
059        var warehouseControl = Session.getModelController(WarehouseControl.class);
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                String defaultInventoryLocationGroupStatusChoice = form.getDefaultInventoryLocationGroupStatusChoice();
071                
072                result.setInventoryLocationGroupStatusChoices(inventoryControl.getInventoryLocationGroupStatusChoices(defaultInventoryLocationGroupStatusChoice,
073                        getPreferredLanguage(), inventoryLocationGroup, getPartyPK()));
074            } else {
075                addExecutionError(ExecutionErrors.UnknownInventoryLocationGroupName.name(), inventoryLocationGroupName);
076            }
077        } else {
078            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
079        }
080        
081        return result;
082    }
083    
084}