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.GetCancellationReasonDescriptionsForm;
020import com.echothree.control.user.cancellationpolicy.common.result.CancellationPolicyResultFactory;
021import com.echothree.control.user.cancellationpolicy.common.result.GetCancellationReasonDescriptionsResult;
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.CancellationReason;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class GetCancellationReasonDescriptionsCommand
043        extends BaseSimpleCommand<GetCancellationReasonDescriptionsForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationReason.name(), SecurityRoles.Description.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetCancellationReasonDescriptionsCommand */
063    public GetCancellationReasonDescriptionsCommand(UserVisitPK userVisitPK, GetCancellationReasonDescriptionsForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
070        GetCancellationReasonDescriptionsResult result = CancellationPolicyResultFactory.getGetCancellationReasonDescriptionsResult();
071        String cancellationKindName = form.getCancellationKindName();
072        CancellationKind cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
073        
074        if(cancellationKind != null) {
075            String cancellationReasonName = form.getCancellationReasonName();
076            CancellationReason cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
077            
078            if(cancellationReason != null) {
079                result.setCancellationReason(cancellationPolicyControl.getCancellationReasonTransfer(getUserVisit(), cancellationReason));
080                result.setCancellationReasonDescriptions(cancellationPolicyControl.getCancellationReasonDescriptionTransfersByCancellationReason(getUserVisit(), cancellationReason));
081            } else {
082                addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
083            }
084        } else {
085            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
086        }
087        
088        return result;
089    }
090    
091}