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