001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collection;
041import java.util.Collections;
042import java.util.List;
043
044public class GetOrderPrioritiesCommand
045        extends BaseMultipleEntitiesCommand<OrderPriority, GetOrderPrioritiesForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.OrderPriority.name(), SecurityRoles.List.name())
055                        )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("OrderTypeName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetOrderPrioritiesCommand */
064    public GetOrderPrioritiesCommand(UserVisitPK userVisitPK, GetOrderPrioritiesForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067
068    OrderType orderType;
069
070    @Override
071    protected Collection<OrderPriority> getEntities() {
072        var orderPriorityControl = Session.getModelController(OrderPriorityControl.class);
073
074        orderType = OrderTypeLogic.getInstance().getOrderTypeByName(this, form.getOrderTypeName());
075
076        return hasExecutionErrors() ? null : orderPriorityControl.getOrderPriorities(orderType);
077    }
078
079    @Override
080    protected BaseResult getResult(Collection<OrderPriority> entities) {
081        var result = OrderResultFactory.getGetOrderPrioritiesResult();
082
083        if(entities != null) {
084            var orderTypeControl = Session.getModelController(OrderTypeControl.class);
085            var orderPriorityControl = Session.getModelController(OrderPriorityControl.class);
086
087            if(session.hasLimit(OrderPriorityFactory.class)) {
088                result.setOrderPriorityCount(orderPriorityControl.countOrderPriorities(orderType));
089            }
090
091            result.setOrderType(orderTypeControl.getOrderTypeTransfer(getUserVisit(), orderType));
092            result.setOrderPriorities(orderPriorityControl.getOrderPriorityTransfers(getUserVisit(), entities));
093        }
094
095        return result;
096    }
097    
098}