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.GetCancellationPolicyForm;
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.CancellationPolicyLogic;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicy;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSingleEntityCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.List;
032
033public class GetCancellationPolicyCommand
034        extends BaseSingleEntityCommand<CancellationPolicy, GetCancellationPolicyForm> {
035
036    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, false, null, null),
042                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, false, null, null),
043                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
044                new FieldDefinition("Key", FieldType.KEY, false, null, null),
045                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
046                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
047        );
048    }
049    
050    /** Creates a new instance of GetCancellationPolicyCommand */
051    public GetCancellationPolicyCommand(UserVisitPK userVisitPK, GetCancellationPolicyForm form) {
052        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
053    }
054
055    @Override
056    protected CancellationPolicy getEntity() {
057        var cancellationPolicy = CancellationPolicyLogic.getInstance().getCancellationPolicyByUniversalSpec(this, form, true);
058
059        if(cancellationPolicy != null) {
060            sendEvent(cancellationPolicy.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
061        }
062
063        return cancellationPolicy;
064    }
065
066    @Override
067    protected BaseResult getResult(CancellationPolicy cancellationPolicy) {
068        var result = CancellationPolicyResultFactory.getGetCancellationPolicyResult();
069
070        if(cancellationPolicy != null) {
071            var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
072
073            result.setCancellationPolicy(cancellationPolicyControl.getCancellationPolicyTransfer(getUserVisit(), cancellationPolicy));
074        }
075
076        return result;
077    }
078
079}