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.index.common;
018
019import com.echothree.control.user.index.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface IndexService
024        extends IndexForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // --------------------------------------------------------------------------------
033    //   Index Types
034    // --------------------------------------------------------------------------------
035    
036    CommandResult createIndexType(UserVisitPK userVisitPK, CreateIndexTypeForm form);
037    
038    CommandResult getIndexTypeChoices(UserVisitPK userVisitPK, GetIndexTypeChoicesForm form);
039    
040    CommandResult getIndexType(UserVisitPK userVisitPK, GetIndexTypeForm form);
041    
042    CommandResult getIndexTypes(UserVisitPK userVisitPK, GetIndexTypesForm form);
043    
044    CommandResult setDefaultIndexType(UserVisitPK userVisitPK, SetDefaultIndexTypeForm form);
045    
046    CommandResult editIndexType(UserVisitPK userVisitPK, EditIndexTypeForm form);
047    
048    CommandResult deleteIndexType(UserVisitPK userVisitPK, DeleteIndexTypeForm form);
049    
050    // --------------------------------------------------------------------------------
051    //   Index Type Descriptions
052    // --------------------------------------------------------------------------------
053    
054    CommandResult createIndexTypeDescription(UserVisitPK userVisitPK, CreateIndexTypeDescriptionForm form);
055    
056    CommandResult getIndexTypeDescription(UserVisitPK userVisitPK, GetIndexTypeDescriptionForm form);
057    
058    CommandResult getIndexTypeDescriptions(UserVisitPK userVisitPK, GetIndexTypeDescriptionsForm form);
059    
060    CommandResult editIndexTypeDescription(UserVisitPK userVisitPK, EditIndexTypeDescriptionForm form);
061    
062    CommandResult deleteIndexTypeDescription(UserVisitPK userVisitPK, DeleteIndexTypeDescriptionForm form);
063    
064    // --------------------------------------------------------------------------------
065    //   Index Fields
066    // --------------------------------------------------------------------------------
067    
068    CommandResult createIndexField(UserVisitPK userVisitPK, CreateIndexFieldForm form);
069    
070    CommandResult getIndexFieldChoices(UserVisitPK userVisitPK, GetIndexFieldChoicesForm form);
071    
072    CommandResult getIndexField(UserVisitPK userVisitPK, GetIndexFieldForm form);
073    
074    CommandResult getIndexFields(UserVisitPK userVisitPK, GetIndexFieldsForm form);
075    
076    CommandResult setDefaultIndexField(UserVisitPK userVisitPK, SetDefaultIndexFieldForm form);
077    
078    CommandResult editIndexField(UserVisitPK userVisitPK, EditIndexFieldForm form);
079    
080    CommandResult deleteIndexField(UserVisitPK userVisitPK, DeleteIndexFieldForm form);
081    
082    // --------------------------------------------------------------------------------
083    //   Index Field Descriptions
084    // --------------------------------------------------------------------------------
085    
086    CommandResult createIndexFieldDescription(UserVisitPK userVisitPK, CreateIndexFieldDescriptionForm form);
087    
088    CommandResult getIndexFieldDescription(UserVisitPK userVisitPK, GetIndexFieldDescriptionForm form);
089    
090    CommandResult getIndexFieldDescriptions(UserVisitPK userVisitPK, GetIndexFieldDescriptionsForm form);
091    
092    CommandResult editIndexFieldDescription(UserVisitPK userVisitPK, EditIndexFieldDescriptionForm form);
093    
094    CommandResult deleteIndexFieldDescription(UserVisitPK userVisitPK, DeleteIndexFieldDescriptionForm form);
095    
096    // --------------------------------------------------------------------------------
097    //   Indexes
098    // --------------------------------------------------------------------------------
099    
100    CommandResult createIndex(UserVisitPK userVisitPK, CreateIndexForm form);
101    
102    CommandResult getIndexChoices(UserVisitPK userVisitPK, GetIndexChoicesForm form);
103    
104    CommandResult getIndex(UserVisitPK userVisitPK, GetIndexForm form);
105    
106    CommandResult getIndexes(UserVisitPK userVisitPK, GetIndexesForm form);
107    
108    CommandResult setDefaultIndex(UserVisitPK userVisitPK, SetDefaultIndexForm form);
109    
110    CommandResult editIndex(UserVisitPK userVisitPK, EditIndexForm form);
111    
112    CommandResult deleteIndex(UserVisitPK userVisitPK, DeleteIndexForm form);
113    
114    // --------------------------------------------------------------------------------
115    //   Index Descriptions
116    // --------------------------------------------------------------------------------
117    
118    CommandResult createIndexDescription(UserVisitPK userVisitPK, CreateIndexDescriptionForm form);
119    
120    CommandResult getIndexDescription(UserVisitPK userVisitPK, GetIndexDescriptionForm form);
121    
122    CommandResult getIndexDescriptions(UserVisitPK userVisitPK, GetIndexDescriptionsForm form);
123    
124    CommandResult editIndexDescription(UserVisitPK userVisitPK, EditIndexDescriptionForm form);
125    
126    CommandResult deleteIndexDescription(UserVisitPK userVisitPK, DeleteIndexDescriptionForm form);
127    
128    // -------------------------------------------------------------------------
129    //   Utilities
130    // -------------------------------------------------------------------------
131    
132    CommandResult updateIndexes(UserVisitPK userVisitPK, UpdateIndexesForm form);
133    
134    CommandResult forceReindex(UserVisitPK userVisitPK, ForceReindexForm form);
135    
136}