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.CancellationReasonEdit;
021import com.echothree.control.user.cancellationpolicy.common.form.EditCancellationReasonForm;
022import com.echothree.control.user.cancellationpolicy.common.result.CancellationPolicyResultFactory;
023import com.echothree.control.user.cancellationpolicy.common.spec.CancellationReasonSpec;
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 EditCancellationReasonCommand
046        extends BaseEditCommand<CancellationReasonSpec, CancellationReasonEdit> {
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.CancellationReason.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("CancellationReasonName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064        
065        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
068                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
069                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
070                ));
071    }
072    
073    /** Creates a new instance of EditCancellationReasonCommand */
074    public EditCancellationReasonCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    protected BaseResult execute() {
080        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
081        var result = CancellationPolicyResultFactory.getEditCancellationReasonResult();
082        var cancellationKindName = spec.getCancellationKindName();
083        var cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
084        
085        if(cancellationKind != null) {
086            if(editMode.equals(EditMode.LOCK)) {
087                var cancellationReasonName = spec.getCancellationReasonName();
088                var cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
089                
090                if(cancellationReason != null) {
091                    result.setCancellationReason(cancellationPolicyControl.getCancellationReasonTransfer(getUserVisit(), cancellationReason));
092                    
093                    if(lockEntity(cancellationReason)) {
094                        var cancellationReasonDescription = cancellationPolicyControl.getCancellationReasonDescription(cancellationReason, getPreferredLanguage());
095                        var edit = CancellationPolicyEditFactory.getCancellationReasonEdit();
096                        var cancellationReasonDetail = cancellationReason.getLastDetail();
097                        
098                        result.setEdit(edit);
099                        edit.setCancellationReasonName(cancellationReasonDetail.getCancellationReasonName());
100                        edit.setIsDefault(cancellationReasonDetail.getIsDefault().toString());
101                        edit.setSortOrder(cancellationReasonDetail.getSortOrder().toString());
102                        
103                        if(cancellationReasonDescription != null)
104                            edit.setDescription(cancellationReasonDescription.getDescription());
105                    } else {
106                        addExecutionError(ExecutionErrors.EntityLockFailed.name());
107                    }
108                    
109                    result.setEntityLock(getEntityLockTransfer(cancellationReason));
110                } else {
111                    addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
112                }
113            } else if(editMode.equals(EditMode.UPDATE)) {
114                var cancellationReasonName = spec.getCancellationReasonName();
115                var cancellationReason = cancellationPolicyControl.getCancellationReasonByNameForUpdate(cancellationKind, cancellationReasonName);
116                
117                if(cancellationReason != null) {
118                    cancellationReasonName = edit.getCancellationReasonName();
119                    var duplicateCancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
120                    
121                    if(duplicateCancellationReason == null || cancellationReason.equals(duplicateCancellationReason)) {
122                        if(lockEntityForUpdate(cancellationReason)) {
123                            try {
124                                var partyPK = getPartyPK();
125                                var cancellationReasonDetailValue = cancellationPolicyControl.getCancellationReasonDetailValueForUpdate(cancellationReason);
126                                var cancellationReasonDescription = cancellationPolicyControl.getCancellationReasonDescriptionForUpdate(cancellationReason, getPreferredLanguage());
127                                var description = edit.getDescription();
128                                
129                                cancellationReasonDetailValue.setCancellationReasonName(edit.getCancellationReasonName());
130                                cancellationReasonDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
131                                cancellationReasonDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
132                                
133                                cancellationPolicyControl.updateCancellationReasonFromValue(cancellationReasonDetailValue, partyPK);
134                                
135                                if(cancellationReasonDescription == null && description != null) {
136                                    cancellationPolicyControl.createCancellationReasonDescription(cancellationReason, getPreferredLanguage(), description, partyPK);
137                                } else if(cancellationReasonDescription != null && description == null) {
138                                    cancellationPolicyControl.deleteCancellationReasonDescription(cancellationReasonDescription, partyPK);
139                                } else if(cancellationReasonDescription != null && description != null) {
140                                    var cancellationReasonDescriptionValue = cancellationPolicyControl.getCancellationReasonDescriptionValue(cancellationReasonDescription);
141                                    
142                                    cancellationReasonDescriptionValue.setDescription(description);
143                                    cancellationPolicyControl.updateCancellationReasonDescriptionFromValue(cancellationReasonDescriptionValue, partyPK);
144                                }
145                            } finally {
146                                unlockEntity(cancellationReason);
147                            }
148                        } else {
149                            addExecutionError(ExecutionErrors.EntityLockStale.name());
150                        }
151                    } else {
152                        addExecutionError(ExecutionErrors.DuplicateCancellationReasonName.name(), cancellationReasonName);
153                    }
154                } else {
155                    addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
156                }
157            }
158        } else {
159            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
160        }
161        
162        return result;
163    }
164    
165}