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.scale.common;
018
019import com.echothree.control.user.scale.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface ScaleService
024        extends ScaleForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // -------------------------------------------------------------------------
033    //   Scale Types
034    // -------------------------------------------------------------------------
035
036    CommandResult createScaleType(UserVisitPK userVisitPK, CreateScaleTypeForm form);
037
038    CommandResult getScaleTypeChoices(UserVisitPK userVisitPK, GetScaleTypeChoicesForm form);
039
040    CommandResult getScaleType(UserVisitPK userVisitPK, GetScaleTypeForm form);
041
042    CommandResult getScaleTypes(UserVisitPK userVisitPK, GetScaleTypesForm form);
043
044    CommandResult setDefaultScaleType(UserVisitPK userVisitPK, SetDefaultScaleTypeForm form);
045
046    CommandResult editScaleType(UserVisitPK userVisitPK, EditScaleTypeForm form);
047
048    CommandResult deleteScaleType(UserVisitPK userVisitPK, DeleteScaleTypeForm form);
049
050    // -------------------------------------------------------------------------
051    //   Scale Type Descriptions
052    // -------------------------------------------------------------------------
053
054    CommandResult createScaleTypeDescription(UserVisitPK userVisitPK, CreateScaleTypeDescriptionForm form);
055
056    CommandResult getScaleTypeDescription(UserVisitPK userVisitPK, GetScaleTypeDescriptionForm form);
057
058    CommandResult getScaleTypeDescriptions(UserVisitPK userVisitPK, GetScaleTypeDescriptionsForm form);
059
060    CommandResult editScaleTypeDescription(UserVisitPK userVisitPK, EditScaleTypeDescriptionForm form);
061
062    CommandResult deleteScaleTypeDescription(UserVisitPK userVisitPK, DeleteScaleTypeDescriptionForm form);
063
064    // -------------------------------------------------------------------------
065    //   Scales
066    // -------------------------------------------------------------------------
067    
068    CommandResult createScale(UserVisitPK userVisitPK, CreateScaleForm form);
069    
070    CommandResult getScaleChoices(UserVisitPK userVisitPK, GetScaleChoicesForm form);
071
072    CommandResult getScale(UserVisitPK userVisitPK, GetScaleForm form);
073
074    CommandResult getScales(UserVisitPK userVisitPK, GetScalesForm form);
075    
076    CommandResult setDefaultScale(UserVisitPK userVisitPK, SetDefaultScaleForm form);
077    
078    CommandResult editScale(UserVisitPK userVisitPK, EditScaleForm form);
079    
080    CommandResult deleteScale(UserVisitPK userVisitPK, DeleteScaleForm form);
081    
082    // -------------------------------------------------------------------------
083    //   Scale Descriptions
084    // -------------------------------------------------------------------------
085    
086    CommandResult createScaleDescription(UserVisitPK userVisitPK, CreateScaleDescriptionForm form);
087    
088    CommandResult getScaleDescription(UserVisitPK userVisitPK, GetScaleDescriptionForm form);
089
090    CommandResult getScaleDescriptions(UserVisitPK userVisitPK, GetScaleDescriptionsForm form);
091
092    CommandResult editScaleDescription(UserVisitPK userVisitPK, EditScaleDescriptionForm form);
093    
094    CommandResult deleteScaleDescription(UserVisitPK userVisitPK, DeleteScaleDescriptionForm form);
095    
096    // -------------------------------------------------------------------------
097    //   Scale Use Types
098    // -------------------------------------------------------------------------
099
100    CommandResult createScaleUseType(UserVisitPK userVisitPK, CreateScaleUseTypeForm form);
101
102    CommandResult getScaleUseTypeChoices(UserVisitPK userVisitPK, GetScaleUseTypeChoicesForm form);
103
104    CommandResult getScaleUseType(UserVisitPK userVisitPK, GetScaleUseTypeForm form);
105
106    CommandResult getScaleUseTypes(UserVisitPK userVisitPK, GetScaleUseTypesForm form);
107
108    CommandResult setDefaultScaleUseType(UserVisitPK userVisitPK, SetDefaultScaleUseTypeForm form);
109
110    CommandResult editScaleUseType(UserVisitPK userVisitPK, EditScaleUseTypeForm form);
111
112    CommandResult deleteScaleUseType(UserVisitPK userVisitPK, DeleteScaleUseTypeForm form);
113
114    // -------------------------------------------------------------------------
115    //   Scale Use Type Descriptions
116    // -------------------------------------------------------------------------
117
118    CommandResult createScaleUseTypeDescription(UserVisitPK userVisitPK, CreateScaleUseTypeDescriptionForm form);
119
120    CommandResult getScaleUseTypeDescription(UserVisitPK userVisitPK, GetScaleUseTypeDescriptionForm form);
121
122    CommandResult getScaleUseTypeDescriptions(UserVisitPK userVisitPK, GetScaleUseTypeDescriptionsForm form);
123
124    CommandResult editScaleUseTypeDescription(UserVisitPK userVisitPK, EditScaleUseTypeDescriptionForm form);
125
126    CommandResult deleteScaleUseTypeDescription(UserVisitPK userVisitPK, DeleteScaleUseTypeDescriptionForm form);
127
128    // -------------------------------------------------------------------------
129    //   Party Scale Uses
130    // -------------------------------------------------------------------------
131
132    CommandResult createPartyScaleUse(UserVisitPK userVisitPK, CreatePartyScaleUseForm form);
133
134    CommandResult getPartyScaleUse(UserVisitPK userVisitPK, GetPartyScaleUseForm form);
135
136    CommandResult getPartyScaleUses(UserVisitPK userVisitPK, GetPartyScaleUsesForm form);
137
138    CommandResult editPartyScaleUse(UserVisitPK userVisitPK, EditPartyScaleUseForm form);
139
140    CommandResult deletePartyScaleUse(UserVisitPK userVisitPK, DeletePartyScaleUseForm form);
141
142}