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.order.server.command;
018
019import com.echothree.control.user.order.common.form.GetOrderPrioritiesForm;
020import com.echothree.control.user.order.common.result.OrderResultFactory;
021import com.echothree.model.control.order.server.control.OrderPriorityControl;
022import com.echothree.model.control.order.server.control.OrderTypeControl;
023import com.echothree.model.control.order.server.logic.OrderTypeLogic;
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.order.server.entity.OrderPriority;
028import com.echothree.model.data.order.server.entity.OrderType;
029import com.echothree.model.data.order.server.factory.OrderPriorityFactory;
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 GetOrderPrioritiesCommand
044        extends BasePaginatedMultipleEntitiesCommand<OrderPriority, GetOrderPrioritiesForm> {
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.OrderPriority.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("OrderTypeName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    OrderPriorityControl orderPriorityControl;
064
065    @Inject
066    OrderTypeControl orderTypeControl;
067
068    @Inject
069    OrderTypeLogic orderTypeLogic;
070
071    
072    /** Creates a new instance of GetOrderPrioritiesCommand */
073    public GetOrderPrioritiesCommand() {
074        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
075    }
076
077    OrderType orderType;
078
079    @Override
080    protected void handleForm() {
081        var orderTypeName = form.getOrderTypeName();
082
083        orderType = orderTypeLogic.getOrderTypeByName(this, orderTypeName);
084    }
085
086    @Override
087    protected Long getTotalEntities() {
088        return hasExecutionErrors() ? null : orderPriorityControl.countOrderPriorities(orderType);
089    }
090
091    @Override
092    protected Collection<OrderPriority> getEntities() {
093        Collection<OrderPriority> orderPriorities = null;
094
095        if(!hasExecutionErrors()) {
096            orderPriorities = orderPriorityControl.getOrderPriorities(orderType);
097        }
098
099        return orderPriorities;
100    }
101
102    @Override
103    protected BaseResult getResult(Collection<OrderPriority> entities) {
104        var result = OrderResultFactory.getGetOrderPrioritiesResult();
105
106        if(entities != null) {
107            var userVisit = getUserVisit();
108
109            if(session.hasLimit(OrderPriorityFactory.class)) {
110                result.setOrderPriorityCount(getTotalEntities());
111            }
112
113            result.setOrderType(orderTypeControl.getOrderTypeTransfer(userVisit, orderType));
114            result.setOrderPriorities(orderPriorityControl.getOrderPriorityTransfers(userVisit, entities));
115        }
116
117        return result;
118    }
119    
120}