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.subscription.server.control.SubscriptionControl;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.persistence.Session;
030import java.util.List;
031import javax.enterprise.context.Dependent;
032
033@Dependent
034public class GetSubscriptionCommand
035        extends BaseSimpleCommand<GetSubscriptionForm> {
036    
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041            new FieldDefinition("SubscriptionName", FieldType.ENTITY_NAME, true, null, null)
042        );
043    }
044    
045    /** Creates a new instance of GetSubscriptionCommand */
046    public GetSubscriptionCommand() {
047        super(null, FORM_FIELD_DEFINITIONS, true);
048    }
049    
050    @Override
051    protected BaseResult execute() {
052        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
053        var result = SubscriptionResultFactory.getGetSubscriptionResult();
054        var subscriptionName = form.getSubscriptionName();
055        var subscription = subscriptionControl.getSubscriptionByName(subscriptionName);
056        
057        if(subscription != null) {
058            result.setSubscription(subscriptionControl.getSubscriptionTransfer(getUserVisit(), subscription));
059            
060            sendEvent(subscription.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
061        } else {
062            addExecutionError(ExecutionErrors.UnknownSubscriptionName.name(), subscriptionName);
063        }
064        
065        return result;
066    }
067    
068}