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 com.echothree.util.server.persistence.Session;
041import java.util.List;
042import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditOrderAliasCommand */
064    public EditOrderAliasCommand() {
065        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
066    }
067
068    @Override
069    protected CommandSecurityDefinition getCommandSecurityDefinition() {
070        return new CommandSecurityDefinition(List.of(
071                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
072                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
073                        new SecurityRoleDefinition(OrderAliasUtil.getInstance().getSecurityRoleGroupNameByOrderTypeSpec(spec), SecurityRoles.Edit.name())
074                ))
075        ));
076    }
077
078    @Override
079    public EditOrderAliasResult getResult() {
080        return OrderResultFactory.getEditOrderAliasResult();
081    }
082
083    @Override
084    public OrderAliasEdit getEdit() {
085        return OrderEditFactory.getOrderAliasEdit();
086    }
087
088    OrderAliasType orderAliasType;
089    
090    @Override
091    public OrderAlias getEntity(EditOrderAliasResult result) {
092        var orderTypeControl = Session.getModelController(OrderTypeControl.class);
093        OrderAlias orderAlias = null;
094        var orderTypeName = spec.getOrderTypeName();
095        var orderType = orderTypeControl.getOrderTypeByName(orderTypeName);
096
097        if(orderType != null) {
098            var orderControl = Session.getModelController(OrderControl.class);
099            var orderName = spec.getOrderName();
100            var order = orderControl.getOrderByName(orderType, orderName);
101
102            if(order != null) {
103                var orderAliasControl = Session.getModelController(OrderAliasControl.class);
104                var orderAliasTypeName = spec.getOrderAliasTypeName();
105
106                orderAliasType = orderAliasControl.getOrderAliasTypeByName(orderType, orderAliasTypeName);
107
108                if(orderAliasType != null) {
109                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
110                        orderAlias = orderAliasControl.getOrderAlias(order, orderAliasType);
111                    } else { // EditMode.UPDATE
112                        orderAlias = orderAliasControl.getOrderAliasForUpdate(order, orderAliasType);
113                    }
114
115                    if(orderAlias != null) {
116                        result.setOrderAlias(orderAliasControl.getOrderAliasTransfer(getUserVisit(), orderAlias));
117                    } else {
118                        addExecutionError(ExecutionErrors.UnknownOrderAlias.name(), orderTypeName, orderName, orderAliasTypeName);
119                    }
120                } else {
121                    addExecutionError(ExecutionErrors.UnknownOrderAliasTypeName.name(), orderTypeName, orderAliasTypeName);
122                }
123            } else {
124                addExecutionError(ExecutionErrors.UnknownOrderName.name(), orderTypeName, orderName);
125            }
126        } else {
127            addExecutionError(ExecutionErrors.UnknownOrderTypeName.name(), orderTypeName);
128        }
129
130        return orderAlias;
131    }
132
133    @Override
134    public OrderAlias getLockEntity(OrderAlias orderAlias) {
135        return orderAlias;
136    }
137
138    @Override
139    public void fillInResult(EditOrderAliasResult result, OrderAlias orderAlias) {
140        var orderAliasControl = Session.getModelController(OrderAliasControl.class);
141
142        result.setOrderAlias(orderAliasControl.getOrderAliasTransfer(getUserVisit(), orderAlias));
143    }
144
145    @Override
146    public void doLock(OrderAliasEdit edit, OrderAlias orderAlias) {
147        edit.setAlias(orderAlias.getAlias());
148    }
149
150    @Override
151    public void canUpdate(OrderAlias orderAlias) {
152        var orderAliasControl = Session.getModelController(OrderAliasControl.class);
153        var alias = edit.getAlias();
154        var duplicateOrderAlias = orderAliasControl.getOrderAliasByAlias(orderAliasType, alias);
155
156        if(duplicateOrderAlias != null && !orderAlias.equals(duplicateOrderAlias)) {
157            var orderAliasTypeDetail = orderAlias.getOrderAliasType().getLastDetail();
158
159            addExecutionError(ExecutionErrors.DuplicateOrderAlias.name(), orderAliasTypeDetail.getOrderType().getLastDetail().getOrderTypeName(),
160                    orderAliasTypeDetail.getOrderAliasTypeName(), alias);
161        }
162    }
163
164    @Override
165    public void doUpdate(OrderAlias orderAlias) {
166        var orderAliasControl = Session.getModelController(OrderAliasControl.class);
167        var orderAliasValue = orderAliasControl.getOrderAliasValue(orderAlias);
168
169        orderAliasValue.setAlias(edit.getAlias());
170
171        orderAliasControl.updateOrderAliasFromValue(orderAliasValue, getPartyPK());
172    }
173
174}