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.picklist.common;
018
019import com.echothree.control.user.picklist.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface PicklistService
024        extends PicklistForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // --------------------------------------------------------------------------------
033    //   Picklist Types
034    // --------------------------------------------------------------------------------
035
036    CommandResult createPicklistType(UserVisitPK userVisitPK, CreatePicklistTypeForm form);
037
038    CommandResult getPicklistTypeChoices(UserVisitPK userVisitPK, GetPicklistTypeChoicesForm form);
039
040    CommandResult getPicklistType(UserVisitPK userVisitPK, GetPicklistTypeForm form);
041
042    CommandResult getPicklistTypes(UserVisitPK userVisitPK, GetPicklistTypesForm form);
043
044    CommandResult setDefaultPicklistType(UserVisitPK userVisitPK, SetDefaultPicklistTypeForm form);
045
046    CommandResult editPicklistType(UserVisitPK userVisitPK, EditPicklistTypeForm form);
047
048    CommandResult deletePicklistType(UserVisitPK userVisitPK, DeletePicklistTypeForm form);
049
050    // --------------------------------------------------------------------------------
051    //   Picklist Type Descriptions
052    // --------------------------------------------------------------------------------
053
054    CommandResult createPicklistTypeDescription(UserVisitPK userVisitPK, CreatePicklistTypeDescriptionForm form);
055
056    CommandResult getPicklistTypeDescription(UserVisitPK userVisitPK, GetPicklistTypeDescriptionForm form);
057
058    CommandResult getPicklistTypeDescriptions(UserVisitPK userVisitPK, GetPicklistTypeDescriptionsForm form);
059
060    CommandResult editPicklistTypeDescription(UserVisitPK userVisitPK, EditPicklistTypeDescriptionForm form);
061
062    CommandResult deletePicklistTypeDescription(UserVisitPK userVisitPK, DeletePicklistTypeDescriptionForm form);
063
064    // --------------------------------------------------------------------------------
065    //   Picklist Time Types
066    // --------------------------------------------------------------------------------
067
068    CommandResult createPicklistTimeType(UserVisitPK userVisitPK, CreatePicklistTimeTypeForm form);
069
070    CommandResult getPicklistTimeTypeChoices(UserVisitPK userVisitPK, GetPicklistTimeTypeChoicesForm form);
071
072    CommandResult getPicklistTimeType(UserVisitPK userVisitPK, GetPicklistTimeTypeForm form);
073
074    CommandResult getPicklistTimeTypes(UserVisitPK userVisitPK, GetPicklistTimeTypesForm form);
075
076    CommandResult setDefaultPicklistTimeType(UserVisitPK userVisitPK, SetDefaultPicklistTimeTypeForm form);
077
078    CommandResult editPicklistTimeType(UserVisitPK userVisitPK, EditPicklistTimeTypeForm form);
079
080    CommandResult deletePicklistTimeType(UserVisitPK userVisitPK, DeletePicklistTimeTypeForm form);
081
082    // --------------------------------------------------------------------------------
083    //   Picklist Time Type Descriptions
084    // --------------------------------------------------------------------------------
085
086    CommandResult createPicklistTimeTypeDescription(UserVisitPK userVisitPK, CreatePicklistTimeTypeDescriptionForm form);
087
088    CommandResult getPicklistTimeTypeDescription(UserVisitPK userVisitPK, GetPicklistTimeTypeDescriptionForm form);
089
090    CommandResult getPicklistTimeTypeDescriptions(UserVisitPK userVisitPK, GetPicklistTimeTypeDescriptionsForm form);
091
092    CommandResult editPicklistTimeTypeDescription(UserVisitPK userVisitPK, EditPicklistTimeTypeDescriptionForm form);
093
094    CommandResult deletePicklistTimeTypeDescription(UserVisitPK userVisitPK, DeletePicklistTimeTypeDescriptionForm form);
095
096    // --------------------------------------------------------------------------------
097    //   Picklist Alias Types
098    // --------------------------------------------------------------------------------
099
100    CommandResult createPicklistAliasType(UserVisitPK userVisitPK, CreatePicklistAliasTypeForm form);
101
102    CommandResult getPicklistAliasTypeChoices(UserVisitPK userVisitPK, GetPicklistAliasTypeChoicesForm form);
103
104    CommandResult getPicklistAliasType(UserVisitPK userVisitPK, GetPicklistAliasTypeForm form);
105
106    CommandResult getPicklistAliasTypes(UserVisitPK userVisitPK, GetPicklistAliasTypesForm form);
107
108    CommandResult setDefaultPicklistAliasType(UserVisitPK userVisitPK, SetDefaultPicklistAliasTypeForm form);
109
110    CommandResult editPicklistAliasType(UserVisitPK userVisitPK, EditPicklistAliasTypeForm form);
111
112    CommandResult deletePicklistAliasType(UserVisitPK userVisitPK, DeletePicklistAliasTypeForm form);
113
114    // --------------------------------------------------------------------------------
115    //   Picklist Alias Type Descriptions
116    // --------------------------------------------------------------------------------
117
118    CommandResult createPicklistAliasTypeDescription(UserVisitPK userVisitPK, CreatePicklistAliasTypeDescriptionForm form);
119
120    CommandResult getPicklistAliasTypeDescription(UserVisitPK userVisitPK, GetPicklistAliasTypeDescriptionForm form);
121
122    CommandResult getPicklistAliasTypeDescriptions(UserVisitPK userVisitPK, GetPicklistAliasTypeDescriptionsForm form);
123
124    CommandResult editPicklistAliasTypeDescription(UserVisitPK userVisitPK, EditPicklistAliasTypeDescriptionForm form);
125
126    CommandResult deletePicklistAliasTypeDescription(UserVisitPK userVisitPK, DeletePicklistAliasTypeDescriptionForm form);
127
128    // --------------------------------------------------------------------------------
129    //   Picklist Aliases
130    // --------------------------------------------------------------------------------
131
132    CommandResult createPicklistAlias(UserVisitPK userVisitPK, CreatePicklistAliasForm form);
133
134    CommandResult getPicklistAlias(UserVisitPK userVisitPK, GetPicklistAliasForm form);
135
136    CommandResult getPicklistAliases(UserVisitPK userVisitPK, GetPicklistAliasesForm form);
137
138    CommandResult editPicklistAlias(UserVisitPK userVisitPK, EditPicklistAliasForm form);
139
140    CommandResult deletePicklistAlias(UserVisitPK userVisitPK, DeletePicklistAliasForm form);
141
142}