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