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.GetInventoryDispositionsForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.InventoryDispositionControl;
022import com.echothree.model.control.inventory.server.control.InventoryTransactionTypeControl;
023import com.echothree.model.control.inventory.server.logic.InventoryTransactionTypeLogic;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.inventory.server.entity.InventoryDisposition;
028import com.echothree.model.data.inventory.server.entity.InventoryTransactionType;
029import com.echothree.model.data.inventory.server.factory.InventoryDispositionFactory;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetInventoryDispositionsCommand
044        extends BasePaginatedMultipleEntitiesCommand<InventoryDisposition, GetInventoryDispositionsForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.InventoryDisposition.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("InventoryTransactionTypeName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    InventoryDispositionControl inventoryDispositionControl;
064
065    @Inject
066    InventoryTransactionTypeControl inventoryTransactionTypeControl;
067
068    @Inject
069    InventoryTransactionTypeLogic inventoryTransactionTypeLogic;
070
071    /** Creates a new instance of GetInventoryDispositionsCommand */
072    public GetInventoryDispositionsCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075
076    InventoryTransactionType inventoryTransactionType;
077
078    @Override
079    protected void handleForm() {
080        var inventoryTransactionTypeName = form.getInventoryTransactionTypeName();
081
082        inventoryTransactionType = inventoryTransactionTypeLogic.getInventoryTransactionTypeByName(this, inventoryTransactionTypeName);
083    }
084
085    @Override
086    protected Long getTotalEntities() {
087        return hasExecutionErrors() ? null
088                : inventoryDispositionControl.countInventoryDispositionsByInventoryTransactionType(inventoryTransactionType);
089    }
090
091    @Override
092    protected Collection<InventoryDisposition> getEntities() {
093        return hasExecutionErrors() ? null : inventoryDispositionControl.getInventoryDispositions(inventoryTransactionType);
094    }
095
096    @Override
097    protected BaseResult getResult(Collection<InventoryDisposition> entities) {
098        var result = InventoryResultFactory.getGetInventoryDispositionsResult();
099
100        if(entities != null) {
101            var userVisit = getUserVisit();
102
103            result.setInventoryTransactionType(
104                    inventoryTransactionTypeControl.getInventoryTransactionTypeTransfer(userVisit, inventoryTransactionType));
105
106            if(session.hasLimit(InventoryDispositionFactory.class)) {
107                result.setInventoryDispositionCount(getTotalEntities());
108            }
109
110            result.setInventoryDispositions(inventoryDispositionControl.getInventoryDispositionTransfers(userVisit, entities));
111        }
112
113        return result;
114    }
115    
116}