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.cancellationpolicy.server.command;
018
019import com.echothree.control.user.cancellationpolicy.common.edit.CancellationPolicyEditFactory;
020import com.echothree.control.user.cancellationpolicy.common.edit.CancellationPolicyReasonEdit;
021import com.echothree.control.user.cancellationpolicy.common.form.EditCancellationPolicyReasonForm;
022import com.echothree.control.user.cancellationpolicy.common.result.CancellationPolicyResultFactory;
023import com.echothree.control.user.cancellationpolicy.common.result.EditCancellationPolicyReasonResult;
024import com.echothree.control.user.cancellationpolicy.common.spec.CancellationPolicyReasonSpec;
025import com.echothree.model.control.cancellationpolicy.server.control.CancellationPolicyControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.cancellationpolicy.server.entity.CancellationKind;
030import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicy;
031import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicyReason;
032import com.echothree.model.data.cancellationpolicy.server.entity.CancellationReason;
033import com.echothree.model.data.cancellationpolicy.server.value.CancellationPolicyReasonValue;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
039import com.echothree.util.common.command.EditMode;
040import com.echothree.util.server.control.BaseEditCommand;
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 EditCancellationPolicyReasonCommand
050        extends BaseEditCommand<CancellationPolicyReasonSpec, CancellationPolicyReasonEdit> {
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.CancellationPolicyReason.name(), SecurityRoles.Edit.name())
061                        )))
062                )));
063        
064        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, true, null, null)
068                ));
069        
070        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
071                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
072                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
073                ));
074    }
075    
076    /** Creates a new instance of EditCancellationPolicyReasonCommand */
077    public EditCancellationPolicyReasonCommand(UserVisitPK userVisitPK, EditCancellationPolicyReasonForm form) {
078        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    protected BaseResult execute() {
083        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
084        EditCancellationPolicyReasonResult result = CancellationPolicyResultFactory.getEditCancellationPolicyReasonResult();
085        String cancellationPolicyName = spec.getCancellationPolicyName();
086        String cancellationKindName = spec.getCancellationKindName();
087        CancellationKind cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
088        
089        if(cancellationKind != null) {
090            CancellationPolicy cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
091            
092            if(cancellationPolicy != null) {
093                String cancellationReasonName = spec.getCancellationReasonName();
094                CancellationReason cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
095                
096                if(cancellationReason != null) {
097                    if(editMode.equals(EditMode.LOCK)) {
098                        CancellationPolicyReason cancellationPolicyReason = cancellationPolicyControl.getCancellationPolicyReason(cancellationPolicy, cancellationReason);
099                        
100                        if(cancellationPolicyReason != null) {
101                            result.setCancellationPolicyReason(cancellationPolicyControl.getCancellationPolicyReasonTransfer(getUserVisit(), cancellationPolicyReason));
102                            
103                            if(lockEntity(cancellationPolicy)) {
104                                CancellationPolicyReasonEdit edit = CancellationPolicyEditFactory.getCancellationPolicyReasonEdit();
105                                
106                                result.setEdit(edit);
107                                edit.setIsDefault(cancellationPolicyReason.getIsDefault().toString());
108                                edit.setSortOrder(cancellationPolicyReason.getSortOrder().toString());
109                                
110                            } else {
111                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
112                            }
113                            
114                            result.setEntityLock(getEntityLockTransfer(cancellationPolicyReason));
115                        } else {
116                            addExecutionError(ExecutionErrors.UnknownCancellationPolicyReason.name());
117                        }
118                    } else if(editMode.equals(EditMode.UPDATE)) {
119                        CancellationPolicyReasonValue cancellationPolicyReasonValue = cancellationPolicyControl.getCancellationPolicyReasonValueForUpdate(cancellationPolicy, cancellationReason);
120                        
121                        if(cancellationPolicyReasonValue != null) {
122                            if(lockEntityForUpdate(cancellationPolicy)) {
123                                try {
124                                    cancellationPolicyReasonValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
125                                    cancellationPolicyReasonValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
126                                    
127                                    cancellationPolicyControl.updateCancellationPolicyReasonFromValue(cancellationPolicyReasonValue, getPartyPK());
128                                } finally {
129                                    unlockEntity(cancellationPolicy);
130                                }
131                            } else {
132                                addExecutionError(ExecutionErrors.EntityLockStale.name());
133                            }
134                        } else {
135                            addExecutionError(ExecutionErrors.UnknownCancellationPolicyReason.name());
136                        }
137                    }
138                } else {
139                    addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
140                }
141            } else {
142                addExecutionError(ExecutionErrors.UnknownCancellationPolicyName.name(), cancellationPolicyName);
143            }
144        } else {
145            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
146        }
147        
148        return result;
149    }
150    
151}