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.GetCancellationPoliciesForm;
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.cancellationpolicy.server.entity.CancellationKind;
026import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicy;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
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.BaseMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Collection;
038import java.util.List;
039
040public class GetCancellationPoliciesCommand
041        extends BaseMultipleEntitiesCommand<CancellationPolicy, GetCancellationPoliciesForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationPolicy.name(), SecurityRoles.List.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null)
056        );
057    }
058    
059    /** Creates a new instance of GetCancellationPoliciesCommand */
060    public GetCancellationPoliciesCommand(UserVisitPK userVisitPK, GetCancellationPoliciesForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
062    }
063
064    CancellationKind cancellationKind;
065
066    @Override
067    protected Collection<CancellationPolicy> getEntities() {
068        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
069        var cancellationKindName = form.getCancellationKindName();
070        Collection<CancellationPolicy> entities = null;
071
072        cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
073
074        if(cancellationKind != null) {
075            entities = cancellationPolicyControl.getCancellationPolicies(cancellationKind);
076        } else {
077            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
078        }
079
080        return entities;
081    }
082
083    @Override
084    protected BaseResult getResult(Collection<CancellationPolicy> entities) {
085        var result = CancellationPolicyResultFactory.getGetCancellationPoliciesResult();
086
087        if(entities != null) {
088            var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
089
090            result.setCancellationKind(cancellationPolicyControl.getCancellationKindTransfer(getUserVisit(), cancellationKind));
091            result.setCancellationPolicies(cancellationPolicyControl.getCancellationPolicyTransfers(getUserVisit(), entities));
092        }
093
094        return result;
095    }
096    
097}