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