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.GetOrderAliasesForm;
020import com.echothree.control.user.order.common.result.OrderResultFactory;
021import com.echothree.control.user.order.server.command.util.OrderAliasUtil;
022import com.echothree.model.control.order.server.control.OrderAliasControl;
023import com.echothree.model.control.order.server.control.OrderControl;
024import com.echothree.model.control.order.server.logic.OrderLogic;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.order.server.entity.Order;
028import com.echothree.model.data.order.server.entity.OrderAlias;
029import com.echothree.model.data.order.server.factory.OrderAliasFactory;
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 GetOrderAliasesCommand
044        extends BasePaginatedMultipleEntitiesCommand<OrderAlias, GetOrderAliasesForm> {
045
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        FORM_FIELD_DEFINITIONS = List.of(
050                new FieldDefinition("OrderTypeName", FieldType.ENTITY_NAME, true, null, null),
051                new FieldDefinition("OrderName", FieldType.ENTITY_NAME, true, null, null)
052        );
053    }
054
055    @Inject
056    OrderAliasControl orderAliasControl;
057
058    @Inject
059    OrderControl orderControl;
060
061    @Inject
062    OrderLogic orderLogic;
063
064    /** Creates a new instance of GetOrderAliasesCommand */
065    public GetOrderAliasesCommand() {
066        super(null, FORM_FIELD_DEFINITIONS, true);
067    }
068
069    @Override
070    protected CommandSecurityDefinition getCommandSecurityDefinition() {
071        return new CommandSecurityDefinition(List.of(
072                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
073                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
074                        new SecurityRoleDefinition(OrderAliasUtil.getInstance().getSecurityRoleGroupNameByOrderTypeSpec(form), SecurityRoles.List.name())
075                ))
076        ));
077    }
078
079    Order order;
080
081    @Override
082    protected void handleForm() {
083        var orderTypeName = form.getOrderTypeName();
084        var orderName = form.getOrderName();
085
086        order = orderLogic.getOrderByName(this, orderTypeName, orderName);
087    }
088
089    @Override
090    protected Long getTotalEntities() {
091        return order == null ? null : orderAliasControl.countOrderAliasByOrder(order);
092    }
093
094    @Override
095    protected Collection<OrderAlias> getEntities() {
096        return order == null ? null : orderAliasControl.getOrderAliasesByOrder(order);
097    }
098
099    @Override
100    protected BaseResult getResult(Collection<OrderAlias> entities) {
101        var result = OrderResultFactory.getGetOrderAliasesResult();
102
103        if(order != null) {
104            var userVisit = getUserVisit();
105
106            result.setOrder(orderControl.getOrderTransfer(userVisit, order));
107
108            if(session.hasLimit(OrderAliasFactory.class)) {
109                result.setOrderAliasCount(getTotalEntities());
110            }
111
112            result.setOrderAliases(orderAliasControl.getOrderAliasTransfersByOrder(userVisit, order));
113        }
114
115        return result;
116    }
117
118}