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.form.GetCancellationReasonForm;
020import com.echothree.control.user.cancellationpolicy.common.result.CancellationPolicyResultFactory;
021import com.echothree.model.control.cancellationpolicy.server.control.CancellationPolicyControl;
022import com.echothree.model.control.cancellationpolicy.server.logic.CancellationKindLogic;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetCancellationReasonCommand
041        extends BaseSimpleCommand<GetCancellationReasonForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationReason.name(), SecurityRoles.Review.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059
060    @Inject
061    CancellationPolicyControl cancellationPolicyControl;
062
063    @Inject
064    CancellationKindLogic cancellationKindLogic;
065
066
067    /** Creates a new instance of GetCancellationReasonCommand */
068    public GetCancellationReasonCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var result = CancellationPolicyResultFactory.getGetCancellationReasonResult();
075        var cancellationKindName = form.getCancellationKindName();
076        var cancellationKind = cancellationKindLogic.getCancellationKindByName(this, cancellationKindName);
077        
078        if(!hasExecutionErrors()) {
079            var cancellationReasonName = form.getCancellationReasonName();
080            var cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
081            
082            if(cancellationReason != null) {
083                result.setCancellationReason(cancellationPolicyControl.getCancellationReasonTransfer(getUserVisit(), cancellationReason));
084                
085                sendEvent(cancellationReason.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
086            } else {
087                addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
088            }
089        }
090        
091        return result;
092    }
093    
094}