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.edit.OrderAliasEdit;
020import com.echothree.control.user.order.common.edit.OrderEditFactory;
021import com.echothree.control.user.order.common.result.EditOrderAliasResult;
022import com.echothree.control.user.order.common.result.OrderResultFactory;
023import com.echothree.control.user.order.common.spec.OrderAliasSpec;
024import com.echothree.control.user.order.server.command.util.OrderAliasUtil;
025import com.echothree.model.control.order.server.control.OrderAliasControl;
026import com.echothree.model.control.order.server.control.OrderControl;
027import com.echothree.model.control.order.server.control.OrderTypeControl;
028import com.echothree.model.control.party.common.PartyTypes;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.order.server.entity.OrderAlias;
031import com.echothree.model.data.order.server.entity.OrderAliasType;
032import com.echothree.util.common.command.EditMode;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class EditOrderAliasCommand
046        extends BaseAbstractEditCommand<OrderAliasSpec, OrderAliasEdit, EditOrderAliasResult, OrderAlias, OrderAlias> {
047    
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        SPEC_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("OrderTypeName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("OrderName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("OrderAliasTypeName", FieldType.ENTITY_NAME, true, null, null)
056        );
057        
058        EDIT_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    OrderAliasControl orderAliasControl;
065
066    @Inject
067    OrderControl orderControl;
068
069    @Inject
070    OrderTypeControl orderTypeControl;
071
072    
073    /** Creates a new instance of EditOrderAliasCommand */
074    public EditOrderAliasCommand() {
075        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077
078    @Override
079    protected CommandSecurityDefinition getCommandSecurityDefinition() {
080        return new CommandSecurityDefinition(List.of(
081                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
082                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
083                        new SecurityRoleDefinition(OrderAliasUtil.getInstance().getSecurityRoleGroupNameByOrderTypeSpec(spec), SecurityRoles.Edit.name())
084                ))
085        ));
086    }
087
088    @Override
089    public EditOrderAliasResult getResult() {
090        return OrderResultFactory.getEditOrderAliasResult();
091    }
092
093    @Override
094    public OrderAliasEdit getEdit() {
095        return OrderEditFactory.getOrderAliasEdit();
096    }
097
098    OrderAliasType orderAliasType;
099    
100    @Override
101    public OrderAlias getEntity(EditOrderAliasResult result) {
102        OrderAlias orderAlias = null;
103        var orderTypeName = spec.getOrderTypeName();
104        var orderType = orderTypeControl.getOrderTypeByName(orderTypeName);
105
106        if(orderType != null) {
107            var orderName = spec.getOrderName();
108            var order = orderControl.getOrderByName(orderType, orderName);
109
110            if(order != null) {
111                var orderAliasTypeName = spec.getOrderAliasTypeName();
112
113                orderAliasType = orderAliasControl.getOrderAliasTypeByName(orderType, orderAliasTypeName);
114
115                if(orderAliasType != null) {
116                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
117                        orderAlias = orderAliasControl.getOrderAlias(order, orderAliasType);
118                    } else { // EditMode.UPDATE
119                        orderAlias = orderAliasControl.getOrderAliasForUpdate(order, orderAliasType);
120                    }
121
122                    if(orderAlias != null) {
123                        result.setOrderAlias(orderAliasControl.getOrderAliasTransfer(getUserVisit(), orderAlias));
124                    } else {
125                        addExecutionError(ExecutionErrors.UnknownOrderAlias.name(), orderTypeName, orderName, orderAliasTypeName);
126                    }
127                } else {
128                    addExecutionError(ExecutionErrors.UnknownOrderAliasTypeName.name(), orderTypeName, orderAliasTypeName);
129                }
130            } else {
131                addExecutionError(ExecutionErrors.UnknownOrderName.name(), orderTypeName, orderName);
132            }
133        } else {
134            addExecutionError(ExecutionErrors.UnknownOrderTypeName.name(), orderTypeName);
135        }
136
137        return orderAlias;
138    }
139
140    @Override
141    public OrderAlias getLockEntity(OrderAlias orderAlias) {
142        return orderAlias;
143    }
144
145    @Override
146    public void fillInResult(EditOrderAliasResult result, OrderAlias orderAlias) {
147        result.setOrderAlias(orderAliasControl.getOrderAliasTransfer(getUserVisit(), orderAlias));
148    }
149
150    @Override
151    public void doLock(OrderAliasEdit edit, OrderAlias orderAlias) {
152        edit.setAlias(orderAlias.getAlias());
153    }
154
155    @Override
156    public void canUpdate(OrderAlias orderAlias) {
157        var alias = edit.getAlias();
158        var duplicateOrderAlias = orderAliasControl.getOrderAliasByAlias(orderAliasType, alias);
159
160        if(duplicateOrderAlias != null && !orderAlias.equals(duplicateOrderAlias)) {
161            var orderAliasTypeDetail = orderAlias.getOrderAliasType().getLastDetail();
162
163            addExecutionError(ExecutionErrors.DuplicateOrderAlias.name(), orderAliasTypeDetail.getOrderType().getLastDetail().getOrderTypeName(),
164                    orderAliasTypeDetail.getOrderAliasTypeName(), alias);
165        }
166    }
167
168    @Override
169    public void doUpdate(OrderAlias orderAlias) {
170        var orderAliasValue = orderAliasControl.getOrderAliasValue(orderAlias);
171
172        orderAliasValue.setAlias(edit.getAlias());
173
174        orderAliasControl.updateOrderAliasFromValue(orderAliasValue, getPartyPK());
175    }
176
177}