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.form.GetCancellationPolicyReasonsForm;
020import com.echothree.control.user.cancellationpolicy.common.result.CancellationPolicyResultFactory;
021import com.echothree.model.control.cancellationpolicy.server.control.CancellationPolicyControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetCancellationPolicyReasonsCommand
042        extends BaseSimpleCommand<GetCancellationPolicyReasonsForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationPolicyReason.name(), SecurityRoles.List.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, false, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetCancellationPolicyReasonsCommand */
063    public GetCancellationPolicyReasonsCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
070        var result = CancellationPolicyResultFactory.getGetCancellationPolicyReasonsResult();
071        var cancellationPolicyName = form.getCancellationPolicyName();
072        var cancellationReasonName = form.getCancellationReasonName();
073        var parameterCount = (cancellationReasonName != null? 1: 0) + (cancellationPolicyName != null? 1: 0);
074        
075        if(parameterCount == 1) {
076            var cancellationKindName = form.getCancellationKindName();
077            var cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
078            
079            if(cancellationKind != null) {
080                if(cancellationPolicyName != null) {
081                    var cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
082                    
083                    if(cancellationPolicy != null) {
084                        result.setCancellationPolicy(cancellationPolicyControl.getCancellationPolicyTransfer(getUserVisit(), cancellationPolicy));
085                        result.setCancellationPolicyReasons(cancellationPolicyControl.getCancellationPolicyReasonTransfersByCancellationPolicy(getUserVisit(), cancellationPolicy));
086                    } else {
087                        addExecutionError(ExecutionErrors.UnknownCancellationPolicyName.name(), cancellationPolicyName);
088                    }
089                } else if(cancellationKindName != null && cancellationReasonName != null) {
090                    var cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
091                    
092                    if(cancellationReason != null) {
093                        result.setCancellationReason(cancellationPolicyControl.getCancellationReasonTransfer(getUserVisit(), cancellationReason));
094                        result.setCancellationPolicyReasons(cancellationPolicyControl.getCancellationPolicyReasonTransfersByCancellationReason(getUserVisit(), cancellationReason));
095                    } else {
096                        addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
097                    }
098                }
099            } else {
100                addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
101            }
102        } else {
103            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
104        }
105        
106        return result;
107    }
108    
109}