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