001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.spec.CancellationPolicyReasonSpec;
024import com.echothree.model.control.cancellationpolicy.server.control.CancellationPolicyControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.common.command.EditMode;
034import com.echothree.util.server.control.BaseEditCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042import javax.enterprise.context.RequestScoped;
043
044@RequestScoped
045public class EditCancellationPolicyReasonCommand
046        extends BaseEditCommand<CancellationPolicyReasonSpec, CancellationPolicyReasonEdit> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
050    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
056                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationPolicyReason.name(), SecurityRoles.Edit.name())
057                        )))
058                )));
059        
060        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
061                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, true, null, null)
064                ));
065        
066        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
067                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
068                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
069                ));
070    }
071    
072    /** Creates a new instance of EditCancellationPolicyReasonCommand */
073    public EditCancellationPolicyReasonCommand() {
074        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
080        var result = CancellationPolicyResultFactory.getEditCancellationPolicyReasonResult();
081        var cancellationPolicyName = spec.getCancellationPolicyName();
082        var cancellationKindName = spec.getCancellationKindName();
083        var cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
084        
085        if(cancellationKind != null) {
086            var cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
087            
088            if(cancellationPolicy != null) {
089                var cancellationReasonName = spec.getCancellationReasonName();
090                var cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
091                
092                if(cancellationReason != null) {
093                    if(editMode.equals(EditMode.LOCK)) {
094                        var cancellationPolicyReason = cancellationPolicyControl.getCancellationPolicyReason(cancellationPolicy, cancellationReason);
095                        
096                        if(cancellationPolicyReason != null) {
097                            result.setCancellationPolicyReason(cancellationPolicyControl.getCancellationPolicyReasonTransfer(getUserVisit(), cancellationPolicyReason));
098                            
099                            if(lockEntity(cancellationPolicy)) {
100                                var edit = CancellationPolicyEditFactory.getCancellationPolicyReasonEdit();
101                                
102                                result.setEdit(edit);
103                                edit.setIsDefault(cancellationPolicyReason.getIsDefault().toString());
104                                edit.setSortOrder(cancellationPolicyReason.getSortOrder().toString());
105                                
106                            } else {
107                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
108                            }
109                            
110                            result.setEntityLock(getEntityLockTransfer(cancellationPolicyReason));
111                        } else {
112                            addExecutionError(ExecutionErrors.UnknownCancellationPolicyReason.name());
113                        }
114                    } else if(editMode.equals(EditMode.UPDATE)) {
115                        var cancellationPolicyReasonValue = cancellationPolicyControl.getCancellationPolicyReasonValueForUpdate(cancellationPolicy, cancellationReason);
116                        
117                        if(cancellationPolicyReasonValue != null) {
118                            if(lockEntityForUpdate(cancellationPolicy)) {
119                                try {
120                                    cancellationPolicyReasonValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
121                                    cancellationPolicyReasonValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
122                                    
123                                    cancellationPolicyControl.updateCancellationPolicyReasonFromValue(cancellationPolicyReasonValue, getPartyPK());
124                                } finally {
125                                    unlockEntity(cancellationPolicy);
126                                }
127                            } else {
128                                addExecutionError(ExecutionErrors.EntityLockStale.name());
129                            }
130                        } else {
131                            addExecutionError(ExecutionErrors.UnknownCancellationPolicyReason.name());
132                        }
133                    }
134                } else {
135                    addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
136                }
137            } else {
138                addExecutionError(ExecutionErrors.UnknownCancellationPolicyName.name(), cancellationPolicyName);
139            }
140        } else {
141            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
142        }
143        
144        return result;
145    }
146    
147}