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.campaign.common;
018
019import com.echothree.control.user.campaign.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface CampaignService
024        extends CampaignForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // --------------------------------------------------------------------------------
033    //   Campaigns
034    // --------------------------------------------------------------------------------
035    
036    CommandResult createCampaign(UserVisitPK userVisitPK, CreateCampaignForm form);
037    
038    CommandResult getCampaignChoices(UserVisitPK userVisitPK, GetCampaignChoicesForm form);
039    
040    CommandResult getCampaign(UserVisitPK userVisitPK, GetCampaignForm form);
041    
042    CommandResult getCampaigns(UserVisitPK userVisitPK, GetCampaignsForm form);
043    
044    CommandResult setDefaultCampaign(UserVisitPK userVisitPK, SetDefaultCampaignForm form);
045    
046    CommandResult getCampaignStatusChoices(UserVisitPK userVisitPK, GetCampaignStatusChoicesForm form);
047    
048    CommandResult setCampaignStatus(UserVisitPK userVisitPK, SetCampaignStatusForm form);
049    
050    CommandResult editCampaign(UserVisitPK userVisitPK, EditCampaignForm form);
051    
052    CommandResult deleteCampaign(UserVisitPK userVisitPK, DeleteCampaignForm form);
053    
054    // --------------------------------------------------------------------------------
055    //   Campaign Descriptions
056    // --------------------------------------------------------------------------------
057    
058    CommandResult createCampaignDescription(UserVisitPK userVisitPK, CreateCampaignDescriptionForm form);
059    
060    CommandResult getCampaignDescription(UserVisitPK userVisitPK, GetCampaignDescriptionForm form);
061    
062    CommandResult getCampaignDescriptions(UserVisitPK userVisitPK, GetCampaignDescriptionsForm form);
063    
064    CommandResult editCampaignDescription(UserVisitPK userVisitPK, EditCampaignDescriptionForm form);
065    
066    CommandResult deleteCampaignDescription(UserVisitPK userVisitPK, DeleteCampaignDescriptionForm form);
067    
068    // --------------------------------------------------------------------------------
069    //   Campaign Sources
070    // --------------------------------------------------------------------------------
071    
072    CommandResult createCampaignSource(UserVisitPK userVisitPK, CreateCampaignSourceForm form);
073    
074    CommandResult getCampaignSourceChoices(UserVisitPK userVisitPK, GetCampaignSourceChoicesForm form);
075    
076    CommandResult getCampaignSource(UserVisitPK userVisitPK, GetCampaignSourceForm form);
077    
078    CommandResult getCampaignSources(UserVisitPK userVisitPK, GetCampaignSourcesForm form);
079    
080    CommandResult setDefaultCampaignSource(UserVisitPK userVisitPK, SetDefaultCampaignSourceForm form);
081    
082    CommandResult getCampaignSourceStatusChoices(UserVisitPK userVisitPK, GetCampaignSourceStatusChoicesForm form);
083    
084    CommandResult setCampaignSourceStatus(UserVisitPK userVisitPK, SetCampaignSourceStatusForm form);
085    
086    CommandResult editCampaignSource(UserVisitPK userVisitPK, EditCampaignSourceForm form);
087    
088    CommandResult deleteCampaignSource(UserVisitPK userVisitPK, DeleteCampaignSourceForm form);
089    
090    // --------------------------------------------------------------------------------
091    //   Campaign Source Descriptions
092    // --------------------------------------------------------------------------------
093    
094    CommandResult createCampaignSourceDescription(UserVisitPK userVisitPK, CreateCampaignSourceDescriptionForm form);
095    
096    CommandResult getCampaignSourceDescription(UserVisitPK userVisitPK, GetCampaignSourceDescriptionForm form);
097    
098    CommandResult getCampaignSourceDescriptions(UserVisitPK userVisitPK, GetCampaignSourceDescriptionsForm form);
099    
100    CommandResult editCampaignSourceDescription(UserVisitPK userVisitPK, EditCampaignSourceDescriptionForm form);
101    
102    CommandResult deleteCampaignSourceDescription(UserVisitPK userVisitPK, DeleteCampaignSourceDescriptionForm form);
103    
104    // --------------------------------------------------------------------------------
105    //   Campaign Mediums
106    // --------------------------------------------------------------------------------
107    
108    CommandResult createCampaignMedium(UserVisitPK userVisitPK, CreateCampaignMediumForm form);
109    
110    CommandResult getCampaignMediumChoices(UserVisitPK userVisitPK, GetCampaignMediumChoicesForm form);
111    
112    CommandResult getCampaignMedium(UserVisitPK userVisitPK, GetCampaignMediumForm form);
113    
114    CommandResult getCampaignMediums(UserVisitPK userVisitPK, GetCampaignMediumsForm form);
115    
116    CommandResult setDefaultCampaignMedium(UserVisitPK userVisitPK, SetDefaultCampaignMediumForm form);
117    
118    CommandResult getCampaignMediumStatusChoices(UserVisitPK userVisitPK, GetCampaignMediumStatusChoicesForm form);
119    
120    CommandResult setCampaignMediumStatus(UserVisitPK userVisitPK, SetCampaignMediumStatusForm form);
121    
122    CommandResult editCampaignMedium(UserVisitPK userVisitPK, EditCampaignMediumForm form);
123    
124    CommandResult deleteCampaignMedium(UserVisitPK userVisitPK, DeleteCampaignMediumForm form);
125    
126    // --------------------------------------------------------------------------------
127    //   Campaign Medium Descriptions
128    // --------------------------------------------------------------------------------
129    
130    CommandResult createCampaignMediumDescription(UserVisitPK userVisitPK, CreateCampaignMediumDescriptionForm form);
131    
132    CommandResult getCampaignMediumDescription(UserVisitPK userVisitPK, GetCampaignMediumDescriptionForm form);
133    
134    CommandResult getCampaignMediumDescriptions(UserVisitPK userVisitPK, GetCampaignMediumDescriptionsForm form);
135    
136    CommandResult editCampaignMediumDescription(UserVisitPK userVisitPK, EditCampaignMediumDescriptionForm form);
137    
138    CommandResult deleteCampaignMediumDescription(UserVisitPK userVisitPK, DeleteCampaignMediumDescriptionForm form);
139    
140    // --------------------------------------------------------------------------------
141    //   Campaign Terms
142    // --------------------------------------------------------------------------------
143    
144    CommandResult createCampaignTerm(UserVisitPK userVisitPK, CreateCampaignTermForm form);
145    
146    CommandResult getCampaignTermChoices(UserVisitPK userVisitPK, GetCampaignTermChoicesForm form);
147    
148    CommandResult getCampaignTerm(UserVisitPK userVisitPK, GetCampaignTermForm form);
149    
150    CommandResult getCampaignTerms(UserVisitPK userVisitPK, GetCampaignTermsForm form);
151    
152    CommandResult setDefaultCampaignTerm(UserVisitPK userVisitPK, SetDefaultCampaignTermForm form);
153    
154    CommandResult getCampaignTermStatusChoices(UserVisitPK userVisitPK, GetCampaignTermStatusChoicesForm form);
155    
156    CommandResult setCampaignTermStatus(UserVisitPK userVisitPK, SetCampaignTermStatusForm form);
157    
158    CommandResult editCampaignTerm(UserVisitPK userVisitPK, EditCampaignTermForm form);
159    
160    CommandResult deleteCampaignTerm(UserVisitPK userVisitPK, DeleteCampaignTermForm form);
161    
162    // --------------------------------------------------------------------------------
163    //   Campaign Term Descriptions
164    // --------------------------------------------------------------------------------
165    
166    CommandResult createCampaignTermDescription(UserVisitPK userVisitPK, CreateCampaignTermDescriptionForm form);
167    
168    CommandResult getCampaignTermDescription(UserVisitPK userVisitPK, GetCampaignTermDescriptionForm form);
169    
170    CommandResult getCampaignTermDescriptions(UserVisitPK userVisitPK, GetCampaignTermDescriptionsForm form);
171    
172    CommandResult editCampaignTermDescription(UserVisitPK userVisitPK, EditCampaignTermDescriptionForm form);
173    
174    CommandResult deleteCampaignTermDescription(UserVisitPK userVisitPK, DeleteCampaignTermDescriptionForm form);
175    
176    // --------------------------------------------------------------------------------
177    //   Campaign Contents
178    // --------------------------------------------------------------------------------
179    
180    CommandResult createCampaignContent(UserVisitPK userVisitPK, CreateCampaignContentForm form);
181    
182    CommandResult getCampaignContentChoices(UserVisitPK userVisitPK, GetCampaignContentChoicesForm form);
183    
184    CommandResult getCampaignContent(UserVisitPK userVisitPK, GetCampaignContentForm form);
185    
186    CommandResult getCampaignContents(UserVisitPK userVisitPK, GetCampaignContentsForm form);
187    
188    CommandResult setDefaultCampaignContent(UserVisitPK userVisitPK, SetDefaultCampaignContentForm form);
189    
190    CommandResult getCampaignContentStatusChoices(UserVisitPK userVisitPK, GetCampaignContentStatusChoicesForm form);
191    
192    CommandResult setCampaignContentStatus(UserVisitPK userVisitPK, SetCampaignContentStatusForm form);
193    
194    CommandResult editCampaignContent(UserVisitPK userVisitPK, EditCampaignContentForm form);
195    
196    CommandResult deleteCampaignContent(UserVisitPK userVisitPK, DeleteCampaignContentForm form);
197    
198    // --------------------------------------------------------------------------------
199    //   Campaign Content Descriptions
200    // --------------------------------------------------------------------------------
201    
202    CommandResult createCampaignContentDescription(UserVisitPK userVisitPK, CreateCampaignContentDescriptionForm form);
203    
204    CommandResult getCampaignContentDescription(UserVisitPK userVisitPK, GetCampaignContentDescriptionForm form);
205    
206    CommandResult getCampaignContentDescriptions(UserVisitPK userVisitPK, GetCampaignContentDescriptionsForm form);
207    
208    CommandResult editCampaignContentDescription(UserVisitPK userVisitPK, EditCampaignContentDescriptionForm form);
209    
210    CommandResult deleteCampaignContentDescription(UserVisitPK userVisitPK, DeleteCampaignContentDescriptionForm form);
211    
212    // --------------------------------------------------------------------------------
213    //   User Visit Tracks
214    // --------------------------------------------------------------------------------
215    
216    CommandResult createUserVisitCampaign(UserVisitPK userVisitPK, CreateUserVisitCampaignForm form);
217    
218}