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.GetInventoryLocationGroupForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.inventory.server.control.InventoryLocationGroupControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.control.warehouse.server.control.WarehouseControl;
027import com.echothree.model.control.warehouse.server.logic.WarehouseLogic;
028import com.echothree.model.data.inventory.server.entity.InventoryLocationGroup;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSingleEntityCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetInventoryLocationGroupCommand
043        extends BaseSingleEntityCommand<InventoryLocationGroup, GetInventoryLocationGroupForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.InventoryLocationGroup.name(), SecurityRoles.Review.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("InventoryLocationGroupName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    InventoryLocationGroupControl inventoryLocationGroupControl;
064
065    @Inject
066    WarehouseControl warehouseControl;
067
068    @Inject
069    WarehouseLogic warehouseLogic;
070
071    /** Creates a new instance of GetInventoryLocationGroupCommand */
072    public GetInventoryLocationGroupCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075    @Override
076    protected InventoryLocationGroup getEntity() {
077        var warehouse = warehouseLogic.getWarehouseByName(this, form.getWarehouseName(), null, null, false);
078        InventoryLocationGroup entity = null;
079
080        if(!hasExecutionErrors()) {
081            var warehouseParty = warehouse.getParty();
082            var inventoryLocationGroupName = form.getInventoryLocationGroupName();
083
084            entity = inventoryLocationGroupControl.getInventoryLocationGroupByName(warehouseParty, inventoryLocationGroupName);
085
086            if(entity != null) {
087                sendEvent(entity.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
088            } else {
089                addExecutionError(ExecutionErrors.UnknownInventoryLocationGroupName.name(), warehouse.getWarehouseName(), inventoryLocationGroupName);
090            }
091        }
092
093        return entity;
094    }
095
096    @Override
097    protected BaseResult getResult(InventoryLocationGroup entity) {
098        var result = InventoryResultFactory.getGetInventoryLocationGroupResult();
099
100        if(entity != null) {
101            result.setInventoryLocationGroup(inventoryLocationGroupControl.getInventoryLocationGroupTransfer(getUserVisit(), entity));
102        }
103
104        return result;
105    }
106
107}