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