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.model.data.cancellationpolicy.server.entity.CancellationReason;
028import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetCancellationReasonCommand
042        extends BaseSingleEntityCommand<CancellationReason, GetCancellationReasonForm> {
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(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationReason.name(), SecurityRoles.Review.name())
052                ))
053        ));
054        
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    @Inject
062    CancellationPolicyControl cancellationPolicyControl;
063
064    @Inject
065    CancellationKindLogic cancellationKindLogic;
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 CancellationReason getEntity() {
074        CancellationReason cancellationReason = null;
075        var cancellationKindName = form.getCancellationKindName();
076        var cancellationKind = cancellationKindLogic.getCancellationKindByName(this, cancellationKindName);
077        
078        if(!hasExecutionErrors()) {
079            var cancellationReasonName = form.getCancellationReasonName();
080
081            cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
082            
083            if(cancellationReason != null) {
084                sendEvent(cancellationReason.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
085            } else {
086                addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationKindName, cancellationReasonName);
087            }
088        }
089        
090        return cancellationReason;
091    }
092
093    @Override
094    protected BaseResult getResult(CancellationReason cancellationReason) {
095        var result = CancellationPolicyResultFactory.getGetCancellationReasonResult();
096
097        if(cancellationReason != null) {
098            result.setCancellationReason(cancellationPolicyControl.getCancellationReasonTransfer(getUserVisit(), cancellationReason));
099        }
100
101        return result;
102    }
103    
104}