001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetAllocationPrioritiesForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.inventory.server.control.InventoryControl;
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.data.inventory.server.entity.AllocationPriority;
026import com.echothree.model.data.inventory.server.factory.AllocationPriorityFactory;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Collection;
035import java.util.List;
036import javax.enterprise.context.RequestScoped;
037
038@RequestScoped
039public class GetAllocationPrioritiesCommand
040        extends BasePaginatedMultipleEntitiesCommand<AllocationPriority, GetAllocationPrioritiesForm> {
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.AllocationPriority.name(), SecurityRoles.List.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of();
054    }
055    
056    /** Creates a new instance of GetAllocationPrioritiesCommand */
057    public GetAllocationPrioritiesCommand() {
058        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
059    }
060
061    @Override
062    protected void handleForm() {
063        // No form fields.
064    }
065
066    @Override
067    protected Long getTotalEntities() {
068        var inventoryControl = Session.getModelController(InventoryControl.class);
069
070        return inventoryControl.countAllocationPriorities();
071    }
072
073    @Override
074    protected Collection<AllocationPriority> getEntities() {
075        var inventoryControl = Session.getModelController(InventoryControl.class);
076
077        return inventoryControl.getAllocationPriorities();
078    }
079
080    @Override
081    protected BaseResult getResult(Collection<AllocationPriority> entities) {
082        var result = InventoryResultFactory.getGetAllocationPrioritiesResult();
083
084        if(entities != null) {
085            var inventoryControl = Session.getModelController(InventoryControl.class);
086
087            if(session.hasLimit(AllocationPriorityFactory.class)) {
088                result.setAllocationPriorityCount(getTotalEntities());
089            }
090
091            result.setAllocationPriorities(inventoryControl.getAllocationPriorityTransfers(getUserVisit(), entities));
092        }
093
094        return result;
095    }
096    
097}