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.content.common; 018 019import com.echothree.control.user.content.common.form.*; 020import com.echothree.model.data.user.common.pk.UserVisitPK; 021import com.echothree.util.common.command.CommandResult; 022 023public interface ContentService 024 extends ContentForms { 025 026 // ------------------------------------------------------------------------- 027 // Testing 028 // ------------------------------------------------------------------------- 029 030 String ping(); 031 032 // -------------------------------------------------------------------------------- 033 // Content Page Area Types 034 // -------------------------------------------------------------------------------- 035 036 CommandResult createContentPageAreaType(UserVisitPK userVisitPK, CreateContentPageAreaTypeForm form); 037 038 CommandResult getContentPageAreaTypeChoices(UserVisitPK userVisitPK, GetContentPageAreaTypeChoicesForm form); 039 040 CommandResult getContentPageAreaType(UserVisitPK userVisitPK, GetContentPageAreaTypeForm form); 041 042 CommandResult getContentPageAreaTypes(UserVisitPK userVisitPK, GetContentPageAreaTypesForm form); 043 044 // -------------------------------------------------------------------------------- 045 // Content Page Area Type Descriptions 046 // -------------------------------------------------------------------------------- 047 048 CommandResult createContentPageAreaTypeDescription(UserVisitPK userVisitPK, CreateContentPageAreaTypeDescriptionForm form); 049 050 // -------------------------------------------------------------------------------- 051 // Content Page Layouts 052 // -------------------------------------------------------------------------------- 053 054 CommandResult createContentPageLayout(UserVisitPK userVisitPK, CreateContentPageLayoutForm form); 055 056 CommandResult getContentPageLayoutChoices(UserVisitPK userVisitPK, GetContentPageLayoutChoicesForm form); 057 058 CommandResult getContentPageLayout(UserVisitPK userVisitPK, GetContentPageLayoutForm form); 059 060 CommandResult getContentPageLayouts(UserVisitPK userVisitPK, GetContentPageLayoutsForm form); 061 062 CommandResult setDefaultContentPageLayout(UserVisitPK userVisitPK, SetDefaultContentPageLayoutForm form); 063 064 CommandResult editContentPageLayout(UserVisitPK userVisitPK, EditContentPageLayoutForm form); 065 066 CommandResult deleteContentPageLayout(UserVisitPK userVisitPK, DeleteContentPageLayoutForm form); 067 068 // -------------------------------------------------------------------------------- 069 // Content Page Layout Descriptions 070 // -------------------------------------------------------------------------------- 071 072 CommandResult createContentPageLayoutDescription(UserVisitPK userVisitPK, CreateContentPageLayoutDescriptionForm form); 073 074 CommandResult getContentPageLayoutDescription(UserVisitPK userVisitPK, GetContentPageLayoutDescriptionForm form); 075 076 CommandResult getContentPageLayoutDescriptions(UserVisitPK userVisitPK, GetContentPageLayoutDescriptionsForm form); 077 078 CommandResult editContentPageLayoutDescription(UserVisitPK userVisitPK, EditContentPageLayoutDescriptionForm form); 079 080 CommandResult deleteContentPageLayoutDescription(UserVisitPK userVisitPK, DeleteContentPageLayoutDescriptionForm form); 081 082 // -------------------------------------------------------------------------------- 083 // Content Page Layout Areas 084 // -------------------------------------------------------------------------------- 085 086 CommandResult createContentPageLayoutArea(UserVisitPK userVisitPK, CreateContentPageLayoutAreaForm form); 087 088 CommandResult getContentPageLayoutArea(UserVisitPK userVisitPK, GetContentPageLayoutAreaForm form); 089 090 CommandResult getContentPageLayoutAreas(UserVisitPK userVisitPK, GetContentPageLayoutAreasForm form); 091 092 // -------------------------------------------------------------------------------- 093 // Content Page Layout Area Descriptions 094 // -------------------------------------------------------------------------------- 095 096 CommandResult createContentPageLayoutAreaDescription(UserVisitPK userVisitPK, CreateContentPageLayoutAreaDescriptionForm form); 097 098 // -------------------------------------------------------------------------------- 099 // Content Collections 100 // -------------------------------------------------------------------------------- 101 102 CommandResult createContentCollection(UserVisitPK userVisitPK, CreateContentCollectionForm form); 103 104 CommandResult getContentCollection(UserVisitPK userVisitPK, GetContentCollectionForm form); 105 106 CommandResult getContentCollections(UserVisitPK userVisitPK, GetContentCollectionsForm form); 107 108 CommandResult editContentCollection(UserVisitPK userVisitPK, EditContentCollectionForm form); 109 110 CommandResult deleteContentCollection(UserVisitPK userVisitPK, DeleteContentCollectionForm form); 111 112 CommandResult getContentCollectionChoices(UserVisitPK userVisitPK, GetContentCollectionChoicesForm form); 113 114 // -------------------------------------------------------------------------------- 115 // Content Collection Descriptions 116 // -------------------------------------------------------------------------------- 117 118 CommandResult createContentCollectionDescription(UserVisitPK userVisitPK, CreateContentCollectionDescriptionForm form); 119 120 CommandResult getContentCollectionDescription(UserVisitPK userVisitPK, GetContentCollectionDescriptionForm form); 121 122 CommandResult getContentCollectionDescriptions(UserVisitPK userVisitPK, GetContentCollectionDescriptionsForm form); 123 124 CommandResult editContentCollectionDescription(UserVisitPK userVisitPK, EditContentCollectionDescriptionForm form); 125 126 CommandResult deleteContentCollectionDescription(UserVisitPK userVisitPK, DeleteContentCollectionDescriptionForm form); 127 128 // -------------------------------------------------------------------------------- 129 // Content Sections 130 // -------------------------------------------------------------------------------- 131 132 CommandResult createContentSection(UserVisitPK userVisitPK, CreateContentSectionForm form); 133 134 CommandResult getContentSection(UserVisitPK userVisitPK, GetContentSectionForm form); 135 136 CommandResult getContentSections(UserVisitPK userVisitPK, GetContentSectionsForm form); 137 138 CommandResult setDefaultContentSection(UserVisitPK userVisitPK, SetDefaultContentSectionForm form); 139 140 CommandResult editContentSection(UserVisitPK userVisitPK, EditContentSectionForm form); 141 142 CommandResult deleteContentSection(UserVisitPK userVisitPK, DeleteContentSectionForm form); 143 144 CommandResult getContentSectionChoices(UserVisitPK userVisitPK, GetContentSectionChoicesForm form); 145 146 // -------------------------------------------------------------------------------- 147 // Content Section Description 148 // -------------------------------------------------------------------------------- 149 150 CommandResult createContentSectionDescription(UserVisitPK userVisitPK, CreateContentSectionDescriptionForm form); 151 152 CommandResult getContentSectionDescription(UserVisitPK userVisitPK, GetContentSectionDescriptionForm form); 153 154 CommandResult getContentSectionDescriptions(UserVisitPK userVisitPK, GetContentSectionDescriptionsForm form); 155 156 CommandResult editContentSectionDescription(UserVisitPK userVisitPK, EditContentSectionDescriptionForm form); 157 158 CommandResult deleteContentSectionDescription(UserVisitPK userVisitPK, DeleteContentSectionDescriptionForm form); 159 160 // -------------------------------------------------------------------------------- 161 // Content Pages 162 // -------------------------------------------------------------------------------- 163 164 CommandResult createContentPage(UserVisitPK userVisitPK, CreateContentPageForm form); 165 166 CommandResult getContentPage(UserVisitPK userVisitPK, GetContentPageForm form); 167 168 CommandResult getContentPages(UserVisitPK userVisitPK, GetContentPagesForm form); 169 170 CommandResult setDefaultContentPage(UserVisitPK userVisitPK, SetDefaultContentPageForm form); 171 172 CommandResult editContentPage(UserVisitPK userVisitPK, EditContentPageForm form); 173 174 CommandResult deleteContentPage(UserVisitPK userVisitPK, DeleteContentPageForm form); 175 176 // -------------------------------------------------------------------------------- 177 // Content Page Descriptions 178 // -------------------------------------------------------------------------------- 179 180 CommandResult createContentPageDescription(UserVisitPK userVisitPK, CreateContentPageDescriptionForm form); 181 182 CommandResult getContentPageDescription(UserVisitPK userVisitPK, GetContentPageDescriptionForm form); 183 184 CommandResult getContentPageDescriptions(UserVisitPK userVisitPK, GetContentPageDescriptionsForm form); 185 186 CommandResult editContentPageDescription(UserVisitPK userVisitPK, EditContentPageDescriptionForm form); 187 188 CommandResult deleteContentPageDescription(UserVisitPK userVisitPK, DeleteContentPageDescriptionForm form); 189 190 // -------------------------------------------------------------------------------- 191 // Content Catalogs 192 // -------------------------------------------------------------------------------- 193 194 CommandResult createContentCatalog(UserVisitPK userVisitPK, CreateContentCatalogForm form); 195 196 CommandResult getContentCatalog(UserVisitPK userVisitPK, GetContentCatalogForm form); 197 198 CommandResult getContentCatalogs(UserVisitPK userVisitPK, GetContentCatalogsForm form); 199 200 CommandResult setDefaultContentCatalog(UserVisitPK userVisitPK, SetDefaultContentCatalogForm form); 201 202 CommandResult editContentCatalog(UserVisitPK userVisitPK, EditContentCatalogForm form); 203 204 CommandResult deleteContentCatalog(UserVisitPK userVisitPK, DeleteContentCatalogForm form); 205 206 // -------------------------------------------------------------------------------- 207 // Content Catalog Descriptions 208 // -------------------------------------------------------------------------------- 209 210 CommandResult createContentCatalogDescription(UserVisitPK userVisitPK, CreateContentCatalogDescriptionForm form); 211 212 CommandResult getContentCatalogDescription(UserVisitPK userVisitPK, GetContentCatalogDescriptionForm form); 213 214 CommandResult getContentCatalogDescriptions(UserVisitPK userVisitPK, GetContentCatalogDescriptionsForm form); 215 216 CommandResult editContentCatalogDescription(UserVisitPK userVisitPK, EditContentCatalogDescriptionForm form); 217 218 CommandResult deleteContentCatalogDescription(UserVisitPK userVisitPK, DeleteContentCatalogDescriptionForm form); 219 220 // -------------------------------------------------------------------------------- 221 // Content Catalog Items 222 // -------------------------------------------------------------------------------- 223 224 CommandResult getContentCatalogItem(UserVisitPK userVisitPK, GetContentCatalogItemForm form); 225 226 CommandResult getContentCatalogItems(UserVisitPK userVisitPK, GetContentCatalogItemsForm form); 227 228 // -------------------------------------------------------------------------------- 229 // Content Categories 230 // -------------------------------------------------------------------------------- 231 232 CommandResult createContentCategory(UserVisitPK userVisitPK, CreateContentCategoryForm form); 233 234 CommandResult getContentCategory(UserVisitPK userVisitPK, GetContentCategoryForm form); 235 236 CommandResult getContentCategories(UserVisitPK userVisitPK, GetContentCategoriesForm form); 237 238 CommandResult setDefaultContentCategory(UserVisitPK userVisitPK, SetDefaultContentCategoryForm form); 239 240 CommandResult editContentCategory(UserVisitPK userVisitPK, EditContentCategoryForm form); 241 242 CommandResult deleteContentCategory(UserVisitPK userVisitPK, DeleteContentCategoryForm form); 243 244 CommandResult getContentCategoryChoices(UserVisitPK userVisitPK, GetContentCategoryChoicesForm form); 245 246 // -------------------------------------------------------------------------------- 247 // Content Category Descriptions 248 // -------------------------------------------------------------------------------- 249 250 CommandResult createContentCategoryDescription(UserVisitPK userVisitPK, CreateContentCategoryDescriptionForm form); 251 252 CommandResult getContentCategoryDescription(UserVisitPK userVisitPK, GetContentCategoryDescriptionForm form); 253 254 CommandResult getContentCategoryDescriptions(UserVisitPK userVisitPK, GetContentCategoryDescriptionsForm form); 255 256 CommandResult editContentCategoryDescription(UserVisitPK userVisitPK, EditContentCategoryDescriptionForm form); 257 258 CommandResult deleteContentCategoryDescription(UserVisitPK userVisitPK, DeleteContentCategoryDescriptionForm form); 259 260 // -------------------------------------------------------------------------------- 261 // Content Category Items 262 // -------------------------------------------------------------------------------- 263 264 CommandResult createContentCategoryItem(UserVisitPK userVisitPK, CreateContentCategoryItemForm form); 265 266 CommandResult getContentCategoryItem(UserVisitPK userVisitPK, GetContentCategoryItemForm form); 267 268 CommandResult getContentCategoryItems(UserVisitPK userVisitPK, GetContentCategoryItemsForm form); 269 270 CommandResult setDefaultContentCategoryItem(UserVisitPK userVisitPK, SetDefaultContentCategoryItemForm form); 271 272 CommandResult editContentCategoryItem(UserVisitPK userVisitPK, EditContentCategoryItemForm form); 273 274 CommandResult deleteContentCategoryItem(UserVisitPK userVisitPK, DeleteContentCategoryItemForm form); 275 276 // -------------------------------------------------------------------------------- 277 // Content Forums 278 // -------------------------------------------------------------------------------- 279 280 CommandResult createContentForum(UserVisitPK userVisitPK, CreateContentForumForm form); 281 282 CommandResult getContentForum(UserVisitPK userVisitPK, GetContentForumForm form); 283 284 CommandResult getContentForums(UserVisitPK userVisitPK, GetContentForumsForm form); 285 286 CommandResult setDefaultContentForum(UserVisitPK userVisitPK, SetDefaultContentForumForm form); 287 288 CommandResult deleteContentForum(UserVisitPK userVisitPK, DeleteContentForumForm form); 289 290 // -------------------------------------------------------------------------------- 291 // Content Web Addresses 292 // -------------------------------------------------------------------------------- 293 294 CommandResult createContentWebAddress(UserVisitPK userVisitPK, CreateContentWebAddressForm form); 295 296 CommandResult getContentWebAddress(UserVisitPK userVisitPK, GetContentWebAddressForm form); 297 298 CommandResult getContentWebAddresses(UserVisitPK userVisitPK, GetContentWebAddressesForm form); 299 300 CommandResult editContentWebAddress(UserVisitPK userVisitPK, EditContentWebAddressForm form); 301 302 CommandResult deleteContentWebAddress(UserVisitPK userVisitPK, DeleteContentWebAddressForm form); 303 304 // -------------------------------------------------------------------------------- 305 // Content Web Address Descriptions 306 // -------------------------------------------------------------------------------- 307 308 CommandResult createContentWebAddressDescription(UserVisitPK userVisitPK, CreateContentWebAddressDescriptionForm form); 309 310 CommandResult getContentWebAddressDescription(UserVisitPK userVisitPK, GetContentWebAddressDescriptionForm form); 311 312 CommandResult getContentWebAddressDescriptions(UserVisitPK userVisitPK, GetContentWebAddressDescriptionsForm form); 313 314 CommandResult editContentWebAddressDescription(UserVisitPK userVisitPK, EditContentWebAddressDescriptionForm form); 315 316 CommandResult deleteContentWebAddressDescription(UserVisitPK userVisitPK, DeleteContentWebAddressDescriptionForm form); 317 318 // -------------------------------------------------------------------------------- 319 // Content Web Address Servers 320 // -------------------------------------------------------------------------------- 321 322 CommandResult createContentWebAddressServer(UserVisitPK userVisitPK, CreateContentWebAddressServerForm form); 323 324 // -------------------------------------------------------------------------------- 325 // Content Page Areas 326 // -------------------------------------------------------------------------------- 327 328 CommandResult createContentPageArea(UserVisitPK userVisitPK, CreateContentPageAreaForm form); 329 330 CommandResult getContentPageArea(UserVisitPK userVisitPK, GetContentPageAreaForm form); 331 332 CommandResult getContentPageAreas(UserVisitPK userVisitPK, GetContentPageAreasForm form); 333 334 CommandResult editContentPageArea(UserVisitPK userVisitPK, EditContentPageAreaForm form); 335 336 CommandResult deleteContentPageArea(UserVisitPK userVisitPK, DeleteContentPageAreaForm form); 337 338}