001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.GetInventoryLocationGroupChoicesForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.InventoryLocationGroupControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.warehouse.server.control.WarehouseControl;
026import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.inject.Inject;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class GetInventoryLocationGroupChoicesCommand
040        extends BaseSimpleCommand<GetInventoryLocationGroupChoicesForm> {
041
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.InventoryLocationGroup.name(), SecurityRoles.Choices.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("DefaultInventoryLocationGroupChoice", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
057        );
058    }
059
060    @Inject
061    InventoryLocationGroupControl inventoryLocationGroupControl;
062
063    @Inject
064    WarehouseControl warehouseControl;
065
066    /** Creates a new instance of GetInventoryLocationGroupChoicesCommand */
067    public GetInventoryLocationGroupChoicesCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070
071    @Override
072    protected BaseResult execute() {
073        var result = InventoryResultFactory.getGetInventoryLocationGroupChoicesResult();
074        var warehouseName = form.getWarehouseName();
075        var warehouse = warehouseControl.getWarehouseByName(warehouseName);
076
077        if(warehouse != null) {
078            var defaultInventoryLocationGroupChoice = form.getDefaultInventoryLocationGroupChoice();
079            var warehouseParty = warehouse.getParty();
080            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
081
082            result.setInventoryLocationGroupChoices(inventoryLocationGroupControl.getInventoryLocationGroupChoicesByWarehouseParty(defaultInventoryLocationGroupChoice,
083                    getPreferredLanguage(), allowNullChoice, warehouseParty));
084        } else {
085            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
086        }
087
088        return result;
089    }
090
091}