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.OrderEditFactory;
020import com.echothree.control.user.order.common.edit.OrderPriorityDescriptionEdit;
021import com.echothree.control.user.order.common.form.EditOrderPriorityDescriptionForm;
022import com.echothree.control.user.order.common.result.EditOrderPriorityDescriptionResult;
023import com.echothree.control.user.order.common.result.OrderResultFactory;
024import com.echothree.control.user.order.common.spec.OrderPriorityDescriptionSpec;
025import com.echothree.model.control.order.server.control.OrderPriorityControl;
026import com.echothree.model.control.order.server.control.OrderTypeControl;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.party.server.control.PartyControl;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.data.order.server.entity.OrderPriority;
032import com.echothree.model.data.order.server.entity.OrderPriorityDescription;
033import com.echothree.model.data.user.common.pk.UserVisitPK;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.server.control.BaseAbstractEditCommand;
039import com.echothree.util.server.control.CommandSecurityDefinition;
040import com.echothree.util.server.control.PartyTypeDefinition;
041import com.echothree.util.server.control.SecurityRoleDefinition;
042import java.util.List;
043import javax.enterprise.context.Dependent;
044import javax.inject.Inject;
045
046@Dependent
047public class EditOrderPriorityDescriptionCommand
048        extends BaseAbstractEditCommand<OrderPriorityDescriptionSpec, OrderPriorityDescriptionEdit, EditOrderPriorityDescriptionResult, OrderPriorityDescription, OrderPriority> {
049    
050    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
051    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
052    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
053    
054    static {
055        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
056                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
057                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
058                        new SecurityRoleDefinition(SecurityRoleGroups.OrderPriority.name(), SecurityRoles.Description.name())
059                ))
060        ));
061        
062        SPEC_FIELD_DEFINITIONS = List.of(
063                new FieldDefinition("OrderTypeName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("OrderPriorityName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
066        );
067        
068        EDIT_FIELD_DEFINITIONS = List.of(
069                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
070        );
071    }
072
073    @Inject
074    OrderPriorityControl orderPriorityControl;
075
076    @Inject
077    OrderTypeControl orderTypeControl;
078
079    @Inject
080    PartyControl partyControl;
081
082    
083    /** Creates a new instance of EditOrderPriorityDescriptionCommand */
084    public EditOrderPriorityDescriptionCommand() {
085        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
086    }
087    
088    @Override
089    public EditOrderPriorityDescriptionResult getResult() {
090        return OrderResultFactory.getEditOrderPriorityDescriptionResult();
091    }
092
093    @Override
094    public OrderPriorityDescriptionEdit getEdit() {
095        return OrderEditFactory.getOrderPriorityDescriptionEdit();
096    }
097
098    @Override
099    public OrderPriorityDescription getEntity(EditOrderPriorityDescriptionResult result) {
100        OrderPriorityDescription orderPriorityDescription = null;
101        var orderTypeName = spec.getOrderTypeName();
102        var orderType = orderTypeControl.getOrderTypeByName(orderTypeName);
103
104        if(orderType != null) {
105            var orderPriorityName = spec.getOrderPriorityName();
106            var orderPriority = orderPriorityControl.getOrderPriorityByName(orderType, orderPriorityName);
107
108            if(orderPriority != null) {
109                var languageIsoName = spec.getLanguageIsoName();
110                var language = partyControl.getLanguageByIsoName(languageIsoName);
111
112                if(language != null) {
113                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
114                        orderPriorityDescription = orderPriorityControl.getOrderPriorityDescription(orderPriority, language);
115                    } else { // EditMode.UPDATE
116                        orderPriorityDescription = orderPriorityControl.getOrderPriorityDescriptionForUpdate(orderPriority, language);
117                    }
118
119                    if(orderPriorityDescription == null) {
120                        addExecutionError(ExecutionErrors.UnknownOrderPriorityDescription.name(), orderTypeName, orderPriorityName, languageIsoName);
121                    }
122                } else {
123                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
124                }
125            } else {
126                addExecutionError(ExecutionErrors.UnknownOrderPriorityName.name(), orderTypeName, orderPriorityName);
127            }
128        } else {
129            addExecutionError(ExecutionErrors.UnknownOrderTypeName.name(), orderTypeName);
130        }
131
132        return orderPriorityDescription;
133    }
134
135    @Override
136    public OrderPriority getLockEntity(OrderPriorityDescription orderPriorityDescription) {
137        return orderPriorityDescription.getOrderPriority();
138    }
139
140    @Override
141    public void fillInResult(EditOrderPriorityDescriptionResult result, OrderPriorityDescription orderPriorityDescription) {
142        result.setOrderPriorityDescription(orderPriorityControl.getOrderPriorityDescriptionTransfer(getUserVisit(), orderPriorityDescription));
143    }
144
145    @Override
146    public void doLock(OrderPriorityDescriptionEdit edit, OrderPriorityDescription orderPriorityDescription) {
147        edit.setDescription(orderPriorityDescription.getDescription());
148    }
149
150    @Override
151    public void doUpdate(OrderPriorityDescription orderPriorityDescription) {
152        var orderPriorityDescriptionValue = orderPriorityControl.getOrderPriorityDescriptionValue(orderPriorityDescription);
153        orderPriorityDescriptionValue.setDescription(edit.getDescription());
154
155        orderPriorityControl.updateOrderPriorityDescriptionFromValue(orderPriorityDescriptionValue, getPartyPK());
156    }
157    
158}