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.subscription.server.command;
018
019import com.echothree.control.user.subscription.common.form.GetSubscriptionForm;
020import com.echothree.control.user.subscription.common.result.SubscriptionResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
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.control.subscription.server.control.SubscriptionControl;
026import com.echothree.model.control.subscription.server.logic.SubscriptionLogic;
027import com.echothree.model.data.subscription.server.entity.Subscription;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetSubscriptionCommand
041        extends BaseSingleEntityCommand<Subscription, GetSubscriptionForm> {
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.Subscription.name(), SecurityRoles.Review.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("SubscriptionName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
057                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
058        );
059    }
060
061    @Inject
062    SubscriptionControl subscriptionControl;
063
064    @Inject
065    SubscriptionLogic subscriptionLogic;
066
067    /** Creates a new instance of GetSubscriptionCommand */
068    public GetSubscriptionCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071
072    @Override
073    protected Subscription getEntity() {
074        var subscription = subscriptionLogic.getSubscriptionByUniversalSpec(this, form);
075
076        if(subscription != null) {
077            sendEvent(subscription.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
078        }
079
080        return subscription;
081    }
082
083    @Override
084    protected BaseResult getResult(Subscription subscription) {
085        var result = SubscriptionResultFactory.getGetSubscriptionResult();
086
087        if(subscription != null) {
088            result.setSubscription(subscriptionControl.getSubscriptionTransfer(getUserVisit(), subscription));
089        }
090
091        return result;
092    }
093
094}