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.OrderPriorityEdit;
021import com.echothree.control.user.order.common.form.EditOrderPriorityForm;
022import com.echothree.control.user.order.common.result.EditOrderPriorityResult;
023import com.echothree.control.user.order.common.result.OrderResultFactory;
024import com.echothree.control.user.order.common.spec.OrderPriorityUniversalSpec;
025import com.echothree.model.control.order.server.control.OrderPriorityControl;
026import com.echothree.model.control.order.server.control.OrderTypeControl;
027import com.echothree.model.control.order.server.logic.OrderPriorityLogic;
028import com.echothree.model.control.party.common.PartyTypes;
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.user.common.pk.UserVisitPK;
033import com.echothree.util.common.command.EditMode;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditOrderPriorityCommand
047        extends BaseAbstractEditCommand<OrderPriorityUniversalSpec, OrderPriorityEdit, EditOrderPriorityResult, OrderPriority, OrderPriority> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.OrderPriority.name(), SecurityRoles.Edit.name())
058                ))
059        ));
060        
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("OrderTypeName", FieldType.ENTITY_NAME, false, null, null),
063                new FieldDefinition("OrderPriorityName", FieldType.ENTITY_NAME, false, null, null),
064                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
065                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
066        );
067        
068        EDIT_FIELD_DEFINITIONS = List.of(
069                new FieldDefinition("OrderPriorityName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("Priority", FieldType.UNSIGNED_INTEGER, true, null, null),
071                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
072                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
073                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
074        );
075    }
076
077    @Inject
078    OrderPriorityControl orderPriorityControl;
079
080    @Inject
081    OrderTypeControl orderTypeControl;
082
083    @Inject
084    OrderPriorityLogic orderPriorityLogic;
085
086    
087    /** Creates a new instance of EditOrderPriorityCommand */
088    public EditOrderPriorityCommand() {
089        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
090    }
091
092    @Override
093    public EditOrderPriorityResult getResult() {
094        return OrderResultFactory.getEditOrderPriorityResult();
095    }
096
097    @Override
098    public OrderPriorityEdit getEdit() {
099        return OrderEditFactory.getOrderPriorityEdit();
100    }
101
102    @Override
103    public OrderPriority getEntity(EditOrderPriorityResult result) {
104        OrderPriority orderPriority;
105
106        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
107            orderPriority = orderPriorityLogic.getOrderPriorityByUniversalSpec(this, spec, false);
108        } else { // EditMode.UPDATE
109            orderPriority = orderPriorityLogic.getOrderPriorityByUniversalSpecForUpdate(this, spec, false);
110        }
111
112
113        return orderPriority;
114    }
115
116    @Override
117    public OrderPriority getLockEntity(OrderPriority orderPriority) {
118        return orderPriority;
119    }
120
121    @Override
122    public void fillInResult(EditOrderPriorityResult result, OrderPriority orderPriority) {
123        result.setOrderPriority(orderPriorityControl.getOrderPriorityTransfer(getUserVisit(), orderPriority));
124    }
125
126    @Override
127    public void doLock(OrderPriorityEdit edit, OrderPriority orderPriority) {
128        var orderPriorityDescription = orderPriorityControl.getOrderPriorityDescription(orderPriority, getPreferredLanguage());
129        var orderPriorityDetail = orderPriority.getLastDetail();
130
131        edit.setOrderPriorityName(orderPriorityDetail.getOrderPriorityName());
132        edit.setPriority(orderPriorityDetail.getPriority().toString());
133        edit.setIsDefault(orderPriorityDetail.getIsDefault().toString());
134        edit.setSortOrder(orderPriorityDetail.getSortOrder().toString());
135
136        if(orderPriorityDescription != null) {
137            edit.setDescription(orderPriorityDescription.getDescription());
138        }
139    }
140
141    @Override
142    public void canUpdate(OrderPriority orderPriority) {
143        var orderTypeName = spec.getOrderTypeName();
144        var orderType = orderTypeControl.getOrderTypeByName(orderTypeName);
145
146        if(orderType != null) {
147            var orderPriorityName = edit.getOrderPriorityName();
148            var duplicateOrderPriority = orderPriorityControl.getOrderPriorityByName(orderType, orderPriorityName);
149
150            if(duplicateOrderPriority != null && !orderPriority.equals(duplicateOrderPriority)) {
151                addExecutionError(ExecutionErrors.DuplicateOrderPriorityName.name(), orderTypeName, orderPriorityName);
152            }
153        } else {
154            addExecutionError(ExecutionErrors.UnknownOrderTypeName.name(), orderTypeName);
155        }
156    }
157
158    @Override
159    public void doUpdate(OrderPriority orderPriority) {
160        var partyPK = getPartyPK();
161        var orderPriorityDetailValue = orderPriorityControl.getOrderPriorityDetailValueForUpdate(orderPriority);
162        var orderPriorityDescription = orderPriorityControl.getOrderPriorityDescriptionForUpdate(orderPriority, getPreferredLanguage());
163        var description = edit.getDescription();
164
165        orderPriorityDetailValue.setOrderPriorityName(edit.getOrderPriorityName());
166        orderPriorityDetailValue.setPriority(Integer.valueOf(edit.getPriority()));
167        orderPriorityDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
168        orderPriorityDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
169
170        orderPriorityLogic.updateOrderPriorityFromValue(this, orderPriorityDetailValue, partyPK);
171
172        if(orderPriorityDescription == null && description != null) {
173            orderPriorityControl.createOrderPriorityDescription(orderPriority, getPreferredLanguage(), description, partyPK);
174        } else {
175            if(orderPriorityDescription != null && description == null) {
176                orderPriorityControl.deleteOrderPriorityDescription(orderPriorityDescription, partyPK);
177            } else {
178                if(orderPriorityDescription != null && description != null) {
179                    var orderPriorityDescriptionValue = orderPriorityControl.getOrderPriorityDescriptionValue(orderPriorityDescription);
180
181                    orderPriorityDescriptionValue.setDescription(description);
182                    orderPriorityControl.updateOrderPriorityDescriptionFromValue(orderPriorityDescriptionValue, partyPK);
183                }
184            }
185        }
186    }
187
188}