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.GetCancellationPolicyReasonsForm;
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.cancellationpolicy.server.logic.CancellationPolicyLogic;
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.CancellationPolicy;
028import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicyReason;
029import com.echothree.model.data.cancellationpolicy.server.entity.CancellationReason;
030import com.echothree.model.data.cancellationpolicy.server.factory.CancellationPolicyReasonFactory;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.Collection;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class GetCancellationPolicyReasonsCommand
046        extends BasePaginatedMultipleEntitiesCommand<CancellationPolicyReason, GetCancellationPolicyReasonsForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationPolicyReason.name(), SecurityRoles.List.name())
056                ))
057        ));
058        
059        FORM_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, false, null, null)
063        );
064    }
065
066    @Inject
067    CancellationPolicyControl cancellationPolicyControl;
068
069    @Inject
070    CancellationKindLogic cancellationKindLogic;
071
072    @Inject
073    CancellationPolicyLogic cancellationPolicyLogic;
074
075
076    /** Creates a new instance of GetCancellationPolicyReasonsCommand */
077    public GetCancellationPolicyReasonsCommand() {
078        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
079    }
080
081    CancellationPolicy cancellationPolicy;
082    CancellationReason cancellationReason;
083
084    @Override
085    protected void handleForm() {
086        var cancellationKindName = form.getCancellationKindName();
087        var cancellationKind = cancellationKindLogic.getCancellationKindByName(this, cancellationKindName);
088
089        if(!hasExecutionErrors()) {
090            var cancellationPolicyName = form.getCancellationPolicyName();
091            var cancellationReasonName = form.getCancellationReasonName();
092            var parameterCount = (cancellationReasonName != null ? 1 : 0) + (cancellationPolicyName != null ? 1 : 0);
093
094            if(parameterCount == 1) {
095                if(cancellationPolicyName != null) {
096                    cancellationPolicy = cancellationPolicyLogic.getCancellationPolicyByName(this, cancellationKind, cancellationPolicyName);
097                } else {
098                    cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
099
100                    if(cancellationReason == null) {
101                        addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationReasonName);
102                    }
103                }
104            } else {
105                addExecutionError(ExecutionErrors.InvalidParameterCount.name());
106            }
107        }
108    }
109
110    @Override
111    protected Long getTotalEntities() {
112        Long total = null;
113
114        if(!hasExecutionErrors()) {
115            if(cancellationPolicy != null) {
116                total = cancellationPolicyControl.countCancellationPolicyReasonsByCancellationPolicy(cancellationPolicy);
117            } else {
118                total = cancellationPolicyControl.countCancellationPolicyReasonsByCancellationReason(cancellationReason);
119            }
120        }
121
122        return total;
123    }
124
125    @Override
126    protected Collection<CancellationPolicyReason> getEntities() {
127        Collection<CancellationPolicyReason> entities = null;
128
129        if(!hasExecutionErrors()) {
130            if(cancellationPolicy != null) {
131                entities = cancellationPolicyControl.getCancellationPolicyReasonsByCancellationPolicy(cancellationPolicy);
132            } else {
133                entities = cancellationPolicyControl.getCancellationPolicyReasonsByCancellationReason(cancellationReason);
134            }
135        }
136
137        return entities;
138    }
139
140    @Override
141    protected BaseResult getResult(Collection<CancellationPolicyReason> entities) {
142        var result = CancellationPolicyResultFactory.getGetCancellationPolicyReasonsResult();
143
144        if(entities != null) {
145            var userVisit = getUserVisit();
146
147            if(cancellationPolicy != null) {
148                result.setCancellationPolicy(cancellationPolicyControl.getCancellationPolicyTransfer(userVisit, cancellationPolicy));
149            } else {
150                result.setCancellationReason(cancellationPolicyControl.getCancellationReasonTransfer(userVisit, cancellationReason));
151            }
152
153            if(session.hasLimit(CancellationPolicyReasonFactory.class)) {
154                result.setCancellationPolicyReasonsCount(getTotalEntities());
155            }
156
157            result.setCancellationPolicyReasons(cancellationPolicyControl.getCancellationPolicyReasonTransfers(userVisit, entities));
158        }
159
160        return result;
161    }
162    
163}