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 java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
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    @Inject
071    CancellationPolicyControl cancellationPolicyControl;
072
073    @Inject
074    PartyControl partyControl;
075
076    
077    /** Creates a new instance of EditCancellationReasonDescriptionCommand */
078    public EditCancellationReasonDescriptionCommand() {
079        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081    
082    @Override
083    protected BaseResult execute() {
084        var result = CancellationPolicyResultFactory.getEditCancellationReasonDescriptionResult();
085        var cancellationKindName = spec.getCancellationKindName();
086        var cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
087        
088        if(cancellationKind != null) {
089            var cancellationReasonName = spec.getCancellationReasonName();
090            var cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
091            
092            if(cancellationReason != null) {
093                var languageIsoName = spec.getLanguageIsoName();
094                var language = partyControl.getLanguageByIsoName(languageIsoName);
095                
096                if(language != null) {
097                    if(editMode.equals(EditMode.LOCK)) {
098                        var cancellationReasonDescription = cancellationPolicyControl.getCancellationReasonDescription(cancellationReason, language);
099                        
100                        if(cancellationReasonDescription != null) {
101                            result.setCancellationReasonDescription(cancellationPolicyControl.getCancellationReasonDescriptionTransfer(getUserVisit(), cancellationReasonDescription));
102                            
103                            if(lockEntity(cancellationReason)) {
104                                var edit = CancellationPolicyEditFactory.getCancellationReasonDescriptionEdit();
105                                
106                                result.setEdit(edit);
107                                edit.setDescription(cancellationReasonDescription.getDescription());
108                            } else {
109                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
110                            }
111                            
112                            result.setEntityLock(getEntityLockTransfer(cancellationReason));
113                        } else {
114                            addExecutionError(ExecutionErrors.UnknownCancellationReasonDescription.name());
115                        }
116                    } else if(editMode.equals(EditMode.UPDATE)) {
117                        var cancellationReasonDescriptionValue = cancellationPolicyControl.getCancellationReasonDescriptionValueForUpdate(cancellationReason, language);
118                        
119                        if(cancellationReasonDescriptionValue != null) {
120                            if(lockEntityForUpdate(cancellationReason)) {
121                                try {
122                                    var description = edit.getDescription();
123                                    
124                                    cancellationReasonDescriptionValue.setDescription(description);
125                                    
126                                    cancellationPolicyControl.updateCancellationReasonDescriptionFromValue(cancellationReasonDescriptionValue, getPartyPK());
127                                } finally {
128                                    unlockEntity(cancellationReason);
129                                }
130                            } else {
131                                addExecutionError(ExecutionErrors.EntityLockStale.name());
132                            }
133                        } else {
134                            addExecutionError(ExecutionErrors.UnknownCancellationReasonDescription.name());
135                        }
136                    }
137                } else {
138                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
139                }
140            } else {
141                addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
142            }
143        } else {
144            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
145        }
146        
147        return result;
148    }
149    
150}