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.batch.common;
018
019import com.echothree.control.user.batch.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface BatchService
024        extends BatchForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // --------------------------------------------------------------------------------
033    //   Batch Types
034    // --------------------------------------------------------------------------------
035    
036    CommandResult createBatchType(UserVisitPK userVisitPK, CreateBatchTypeForm form);
037    
038    CommandResult getBatchTypeChoices(UserVisitPK userVisitPK, GetBatchTypeChoicesForm form);
039    
040    CommandResult getBatchType(UserVisitPK userVisitPK, GetBatchTypeForm form);
041    
042    CommandResult getBatchTypes(UserVisitPK userVisitPK, GetBatchTypesForm form);
043    
044    CommandResult setDefaultBatchType(UserVisitPK userVisitPK, SetDefaultBatchTypeForm form);
045    
046    CommandResult editBatchType(UserVisitPK userVisitPK, EditBatchTypeForm form);
047    
048    CommandResult deleteBatchType(UserVisitPK userVisitPK, DeleteBatchTypeForm form);
049    
050    // --------------------------------------------------------------------------------
051    //   Batch Type Descriptions
052    // --------------------------------------------------------------------------------
053
054    CommandResult createBatchTypeDescription(UserVisitPK userVisitPK, CreateBatchTypeDescriptionForm form);
055
056    CommandResult getBatchTypeDescription(UserVisitPK userVisitPK, GetBatchTypeDescriptionForm form);
057
058    CommandResult getBatchTypeDescriptions(UserVisitPK userVisitPK, GetBatchTypeDescriptionsForm form);
059
060    CommandResult editBatchTypeDescription(UserVisitPK userVisitPK, EditBatchTypeDescriptionForm form);
061
062    CommandResult deleteBatchTypeDescription(UserVisitPK userVisitPK, DeleteBatchTypeDescriptionForm form);
063
064    // --------------------------------------------------------------------------------
065    //   Batch Type Entity Types
066    // --------------------------------------------------------------------------------
067
068    CommandResult createBatchTypeEntityType(UserVisitPK userVisitPK, CreateBatchTypeEntityTypeForm form);
069
070    CommandResult getBatchTypeEntityType(UserVisitPK userVisitPK, GetBatchTypeEntityTypeForm form);
071
072    CommandResult getBatchTypeEntityTypes(UserVisitPK userVisitPK, GetBatchTypeEntityTypesForm form);
073
074    CommandResult deleteBatchTypeEntityType(UserVisitPK userVisitPK, DeleteBatchTypeEntityTypeForm form);
075
076    // --------------------------------------------------------------------------------
077    //   Batch Alias Types
078    // --------------------------------------------------------------------------------
079
080    CommandResult createBatchAliasType(UserVisitPK userVisitPK, CreateBatchAliasTypeForm form);
081
082    CommandResult getBatchAliasTypeChoices(UserVisitPK userVisitPK, GetBatchAliasTypeChoicesForm form);
083
084    CommandResult getBatchAliasType(UserVisitPK userVisitPK, GetBatchAliasTypeForm form);
085
086    CommandResult getBatchAliasTypes(UserVisitPK userVisitPK, GetBatchAliasTypesForm form);
087
088    CommandResult setDefaultBatchAliasType(UserVisitPK userVisitPK, SetDefaultBatchAliasTypeForm form);
089
090    CommandResult editBatchAliasType(UserVisitPK userVisitPK, EditBatchAliasTypeForm form);
091
092    CommandResult deleteBatchAliasType(UserVisitPK userVisitPK, DeleteBatchAliasTypeForm form);
093
094    // --------------------------------------------------------------------------------
095    //   Batch Alias Type Descriptions
096    // --------------------------------------------------------------------------------
097
098    CommandResult createBatchAliasTypeDescription(UserVisitPK userVisitPK, CreateBatchAliasTypeDescriptionForm form);
099
100    CommandResult getBatchAliasTypeDescription(UserVisitPK userVisitPK, GetBatchAliasTypeDescriptionForm form);
101
102    CommandResult getBatchAliasTypeDescriptions(UserVisitPK userVisitPK, GetBatchAliasTypeDescriptionsForm form);
103
104    CommandResult editBatchAliasTypeDescription(UserVisitPK userVisitPK, EditBatchAliasTypeDescriptionForm form);
105
106    CommandResult deleteBatchAliasTypeDescription(UserVisitPK userVisitPK, DeleteBatchAliasTypeDescriptionForm form);
107
108    // --------------------------------------------------------------------------------
109    //   Batch Aliases
110    // --------------------------------------------------------------------------------
111
112    CommandResult createBatchAlias(UserVisitPK userVisitPK, CreateBatchAliasForm form);
113
114    CommandResult getBatchAlias(UserVisitPK userVisitPK, GetBatchAliasForm form);
115
116    CommandResult getBatchAliases(UserVisitPK userVisitPK, GetBatchAliasesForm form);
117
118    CommandResult editBatchAlias(UserVisitPK userVisitPK, EditBatchAliasForm form);
119
120    CommandResult deleteBatchAlias(UserVisitPK userVisitPK, DeleteBatchAliasForm form);
121
122}