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.common;
018
019import com.echothree.control.user.subscription.common.form.*;
020import com.echothree.control.user.subscription.common.result.*;
021import com.echothree.model.data.user.common.pk.UserVisitPK;
022import com.echothree.util.common.command.CommandResult;
023import com.echothree.util.common.command.VoidResult;
024
025public interface SubscriptionService
026        extends SubscriptionForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // -------------------------------------------------------------------------
035    //   Subscription Kinds
036    // -------------------------------------------------------------------------
037
038    CommandResult<VoidResult> createSubscriptionKind(UserVisitPK userVisitPK, CreateSubscriptionKindForm form);
039
040    CommandResult<GetSubscriptionKindsResult> getSubscriptionKinds(UserVisitPK userVisitPK, GetSubscriptionKindsForm form);
041
042    CommandResult<GetSubscriptionKindResult> getSubscriptionKind(UserVisitPK userVisitPK, GetSubscriptionKindForm form);
043
044    CommandResult<GetSubscriptionKindChoicesResult> getSubscriptionKindChoices(UserVisitPK userVisitPK, GetSubscriptionKindChoicesForm form);
045
046    CommandResult<VoidResult> setDefaultSubscriptionKind(UserVisitPK userVisitPK, SetDefaultSubscriptionKindForm form);
047
048    CommandResult<EditSubscriptionKindResult> editSubscriptionKind(UserVisitPK userVisitPK, EditSubscriptionKindForm form);
049
050    CommandResult<VoidResult> deleteSubscriptionKind(UserVisitPK userVisitPK, DeleteSubscriptionKindForm form);
051
052    // -------------------------------------------------------------------------
053    //   Subscription Kind Descriptions
054    // -------------------------------------------------------------------------
055
056    CommandResult<VoidResult> createSubscriptionKindDescription(UserVisitPK userVisitPK, CreateSubscriptionKindDescriptionForm form);
057
058    CommandResult<GetSubscriptionKindDescriptionsResult> getSubscriptionKindDescriptions(UserVisitPK userVisitPK, GetSubscriptionKindDescriptionsForm form);
059
060    CommandResult<GetSubscriptionKindDescriptionResult> getSubscriptionKindDescription(UserVisitPK userVisitPK, GetSubscriptionKindDescriptionForm form);
061
062    CommandResult<EditSubscriptionKindDescriptionResult> editSubscriptionKindDescription(UserVisitPK userVisitPK, EditSubscriptionKindDescriptionForm form);
063
064    CommandResult<VoidResult> deleteSubscriptionKindDescription(UserVisitPK userVisitPK, DeleteSubscriptionKindDescriptionForm form);
065
066    // --------------------------------------------------------------------------------
067    //   Subscription Types
068    // --------------------------------------------------------------------------------
069    
070    CommandResult<VoidResult> createSubscriptionType(UserVisitPK userVisitPK, CreateSubscriptionTypeForm form);
071    
072    CommandResult<GetSubscriptionTypesResult> getSubscriptionTypes(UserVisitPK userVisitPK, GetSubscriptionTypesForm form);
073    
074    CommandResult<GetSubscriptionTypeResult> getSubscriptionType(UserVisitPK userVisitPK, GetSubscriptionTypeForm form);
075    
076    CommandResult<GetSubscriptionTypeChoicesResult> getSubscriptionTypeChoices(UserVisitPK userVisitPK, GetSubscriptionTypeChoicesForm form);
077    
078    CommandResult<VoidResult> setDefaultSubscriptionType(UserVisitPK userVisitPK, SetDefaultSubscriptionTypeForm form);
079    
080    CommandResult<EditSubscriptionTypeResult> editSubscriptionType(UserVisitPK userVisitPK, EditSubscriptionTypeForm form);
081    
082    CommandResult<VoidResult> deleteSubscriptionType(UserVisitPK userVisitPK, DeleteSubscriptionTypeForm form);
083    
084    // --------------------------------------------------------------------------------
085    //   Subscription Type Descriptions
086    // --------------------------------------------------------------------------------
087    
088    CommandResult<VoidResult> createSubscriptionTypeDescription(UserVisitPK userVisitPK, CreateSubscriptionTypeDescriptionForm form);
089    
090    CommandResult<GetSubscriptionTypeDescriptionsResult> getSubscriptionTypeDescriptions(UserVisitPK userVisitPK, GetSubscriptionTypeDescriptionsForm form);
091    
092    CommandResult<EditSubscriptionTypeDescriptionResult> editSubscriptionTypeDescription(UserVisitPK userVisitPK, EditSubscriptionTypeDescriptionForm form);
093    
094    CommandResult<VoidResult> deleteSubscriptionTypeDescription(UserVisitPK userVisitPK, DeleteSubscriptionTypeDescriptionForm form);
095    
096    // --------------------------------------------------------------------------------
097    //   Subscription Type Chains
098    // --------------------------------------------------------------------------------
099    
100    CommandResult<VoidResult> createSubscriptionTypeChain(UserVisitPK userVisitPK, CreateSubscriptionTypeChainForm form);
101    
102    CommandResult<GetSubscriptionTypeChainsResult> getSubscriptionTypeChains(UserVisitPK userVisitPK, GetSubscriptionTypeChainsForm form);
103    
104    CommandResult<VoidResult> deleteSubscriptionTypeChain(UserVisitPK userVisitPK, DeleteSubscriptionTypeChainForm form);
105    
106    // --------------------------------------------------------------------------------
107    //   Subscriptions
108    // --------------------------------------------------------------------------------
109    
110    CommandResult<VoidResult> createSubscription(UserVisitPK userVisitPK, CreateSubscriptionForm form);
111    
112    CommandResult<GetSubscriptionsResult> getSubscriptions(UserVisitPK userVisitPK, GetSubscriptionsForm form);
113    
114    CommandResult<GetSubscriptionResult> getSubscription(UserVisitPK userVisitPK, GetSubscriptionForm form);
115    
116    CommandResult<VoidResult> deleteSubscription(UserVisitPK userVisitPK, DeleteSubscriptionForm form);
117    
118}