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.CancellationReasonDescriptionEdit;
021import com.echothree.control.user.cancellationpolicy.common.form.EditCancellationReasonDescriptionForm;
022import com.echothree.control.user.cancellationpolicy.common.result.CancellationPolicyResultFactory;
023import com.echothree.control.user.cancellationpolicy.common.spec.CancellationReasonDescriptionSpec;
024import com.echothree.model.control.cancellationpolicy.server.control.CancellationPolicyControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042
043@Dependent
044public class EditCancellationReasonDescriptionCommand
045        extends BaseEditCommand<CancellationReasonDescriptionSpec, CancellationReasonDescriptionEdit> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationReason.name(), SecurityRoles.Description.name())
056                        ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063                );
064        
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
067                );
068    }
069    
070    /** Creates a new instance of EditCancellationReasonDescriptionCommand */
071    public EditCancellationReasonDescriptionCommand() {
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.getEditCancellationReasonDescriptionResult();
079        var cancellationKindName = spec.getCancellationKindName();
080        var cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
081        
082        if(cancellationKind != null) {
083            var cancellationReasonName = spec.getCancellationReasonName();
084            var cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
085            
086            if(cancellationReason != null) {
087                var partyControl = Session.getModelController(PartyControl.class);
088                var languageIsoName = spec.getLanguageIsoName();
089                var language = partyControl.getLanguageByIsoName(languageIsoName);
090                
091                if(language != null) {
092                    if(editMode.equals(EditMode.LOCK)) {
093                        var cancellationReasonDescription = cancellationPolicyControl.getCancellationReasonDescription(cancellationReason, language);
094                        
095                        if(cancellationReasonDescription != null) {
096                            result.setCancellationReasonDescription(cancellationPolicyControl.getCancellationReasonDescriptionTransfer(getUserVisit(), cancellationReasonDescription));
097                            
098                            if(lockEntity(cancellationReason)) {
099                                var edit = CancellationPolicyEditFactory.getCancellationReasonDescriptionEdit();
100                                
101                                result.setEdit(edit);
102                                edit.setDescription(cancellationReasonDescription.getDescription());
103                            } else {
104                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
105                            }
106                            
107                            result.setEntityLock(getEntityLockTransfer(cancellationReason));
108                        } else {
109                            addExecutionError(ExecutionErrors.UnknownCancellationReasonDescription.name());
110                        }
111                    } else if(editMode.equals(EditMode.UPDATE)) {
112                        var cancellationReasonDescriptionValue = cancellationPolicyControl.getCancellationReasonDescriptionValueForUpdate(cancellationReason, language);
113                        
114                        if(cancellationReasonDescriptionValue != null) {
115                            if(lockEntityForUpdate(cancellationReason)) {
116                                try {
117                                    var description = edit.getDescription();
118                                    
119                                    cancellationReasonDescriptionValue.setDescription(description);
120                                    
121                                    cancellationPolicyControl.updateCancellationReasonDescriptionFromValue(cancellationReasonDescriptionValue, getPartyPK());
122                                } finally {
123                                    unlockEntity(cancellationReason);
124                                }
125                            } else {
126                                addExecutionError(ExecutionErrors.EntityLockStale.name());
127                            }
128                        } else {
129                            addExecutionError(ExecutionErrors.UnknownCancellationReasonDescription.name());
130                        }
131                    }
132                } else {
133                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
134                }
135            } else {
136                addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
137            }
138        } else {
139            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
140        }
141        
142        return result;
143    }
144    
145}