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.order.common;
018
019import com.echothree.control.user.order.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface OrderService
024        extends OrderForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // -------------------------------------------------------------------------
033    //   Order Role Types
034    // -------------------------------------------------------------------------
035    
036    CommandResult createOrderRoleType(UserVisitPK userVisitPK, CreateOrderRoleTypeForm form);
037    
038    // -------------------------------------------------------------------------
039    //   Order Role Type Descriptions
040    // -------------------------------------------------------------------------
041    
042    CommandResult createOrderRoleTypeDescription(UserVisitPK userVisitPK, CreateOrderRoleTypeDescriptionForm form);
043    
044    // --------------------------------------------------------------------------------
045    //   Order Types
046    // --------------------------------------------------------------------------------
047
048    CommandResult createOrderType(UserVisitPK userVisitPK, CreateOrderTypeForm form);
049
050    CommandResult getOrderTypeChoices(UserVisitPK userVisitPK, GetOrderTypeChoicesForm form);
051
052    CommandResult getOrderType(UserVisitPK userVisitPK, GetOrderTypeForm form);
053
054    CommandResult getOrderTypes(UserVisitPK userVisitPK, GetOrderTypesForm form);
055
056    CommandResult setDefaultOrderType(UserVisitPK userVisitPK, SetDefaultOrderTypeForm form);
057
058    CommandResult editOrderType(UserVisitPK userVisitPK, EditOrderTypeForm form);
059
060    CommandResult deleteOrderType(UserVisitPK userVisitPK, DeleteOrderTypeForm form);
061
062    // --------------------------------------------------------------------------------
063    //   Order Type Descriptions
064    // --------------------------------------------------------------------------------
065
066    CommandResult createOrderTypeDescription(UserVisitPK userVisitPK, CreateOrderTypeDescriptionForm form);
067
068    CommandResult getOrderTypeDescription(UserVisitPK userVisitPK, GetOrderTypeDescriptionForm form);
069
070    CommandResult getOrderTypeDescriptions(UserVisitPK userVisitPK, GetOrderTypeDescriptionsForm form);
071
072    CommandResult editOrderTypeDescription(UserVisitPK userVisitPK, EditOrderTypeDescriptionForm form);
073
074    CommandResult deleteOrderTypeDescription(UserVisitPK userVisitPK, DeleteOrderTypeDescriptionForm form);
075
076    // --------------------------------------------------------------------------------
077    //   Order Time Types
078    // --------------------------------------------------------------------------------
079
080    CommandResult createOrderTimeType(UserVisitPK userVisitPK, CreateOrderTimeTypeForm form);
081
082    CommandResult getOrderTimeTypeChoices(UserVisitPK userVisitPK, GetOrderTimeTypeChoicesForm form);
083
084    CommandResult getOrderTimeType(UserVisitPK userVisitPK, GetOrderTimeTypeForm form);
085
086    CommandResult getOrderTimeTypes(UserVisitPK userVisitPK, GetOrderTimeTypesForm form);
087
088    CommandResult setDefaultOrderTimeType(UserVisitPK userVisitPK, SetDefaultOrderTimeTypeForm form);
089
090    CommandResult editOrderTimeType(UserVisitPK userVisitPK, EditOrderTimeTypeForm form);
091
092    CommandResult deleteOrderTimeType(UserVisitPK userVisitPK, DeleteOrderTimeTypeForm form);
093
094    // --------------------------------------------------------------------------------
095    //   Order Time Type Descriptions
096    // --------------------------------------------------------------------------------
097
098    CommandResult createOrderTimeTypeDescription(UserVisitPK userVisitPK, CreateOrderTimeTypeDescriptionForm form);
099
100    CommandResult getOrderTimeTypeDescription(UserVisitPK userVisitPK, GetOrderTimeTypeDescriptionForm form);
101
102    CommandResult getOrderTimeTypeDescriptions(UserVisitPK userVisitPK, GetOrderTimeTypeDescriptionsForm form);
103
104    CommandResult editOrderTimeTypeDescription(UserVisitPK userVisitPK, EditOrderTimeTypeDescriptionForm form);
105
106    CommandResult deleteOrderTimeTypeDescription(UserVisitPK userVisitPK, DeleteOrderTimeTypeDescriptionForm form);
107
108    // --------------------------------------------------------------------------------
109    //   Order Alias Types
110    // --------------------------------------------------------------------------------
111
112    CommandResult createOrderAliasType(UserVisitPK userVisitPK, CreateOrderAliasTypeForm form);
113
114    CommandResult getOrderAliasTypeChoices(UserVisitPK userVisitPK, GetOrderAliasTypeChoicesForm form);
115
116    CommandResult getOrderAliasType(UserVisitPK userVisitPK, GetOrderAliasTypeForm form);
117
118    CommandResult getOrderAliasTypes(UserVisitPK userVisitPK, GetOrderAliasTypesForm form);
119
120    CommandResult setDefaultOrderAliasType(UserVisitPK userVisitPK, SetDefaultOrderAliasTypeForm form);
121
122    CommandResult editOrderAliasType(UserVisitPK userVisitPK, EditOrderAliasTypeForm form);
123
124    CommandResult deleteOrderAliasType(UserVisitPK userVisitPK, DeleteOrderAliasTypeForm form);
125
126    // --------------------------------------------------------------------------------
127    //   Order Alias Type Descriptions
128    // --------------------------------------------------------------------------------
129
130    CommandResult createOrderAliasTypeDescription(UserVisitPK userVisitPK, CreateOrderAliasTypeDescriptionForm form);
131
132    CommandResult getOrderAliasTypeDescription(UserVisitPK userVisitPK, GetOrderAliasTypeDescriptionForm form);
133
134    CommandResult getOrderAliasTypeDescriptions(UserVisitPK userVisitPK, GetOrderAliasTypeDescriptionsForm form);
135
136    CommandResult editOrderAliasTypeDescription(UserVisitPK userVisitPK, EditOrderAliasTypeDescriptionForm form);
137
138    CommandResult deleteOrderAliasTypeDescription(UserVisitPK userVisitPK, DeleteOrderAliasTypeDescriptionForm form);
139
140    // --------------------------------------------------------------------------------
141    //   Order Aliases
142    // --------------------------------------------------------------------------------
143
144    CommandResult createOrderAlias(UserVisitPK userVisitPK, CreateOrderAliasForm form);
145
146    CommandResult getOrderAlias(UserVisitPK userVisitPK, GetOrderAliasForm form);
147
148    CommandResult getOrderAliases(UserVisitPK userVisitPK, GetOrderAliasesForm form);
149
150    CommandResult editOrderAlias(UserVisitPK userVisitPK, EditOrderAliasForm form);
151
152    CommandResult deleteOrderAlias(UserVisitPK userVisitPK, DeleteOrderAliasForm form);
153
154    // --------------------------------------------------------------------------------
155    //   Order Priorities
156    // --------------------------------------------------------------------------------
157
158    CommandResult createOrderPriority(UserVisitPK userVisitPK, CreateOrderPriorityForm form);
159
160    CommandResult getOrderPriorityChoices(UserVisitPK userVisitPK, GetOrderPriorityChoicesForm form);
161
162    CommandResult getOrderPriority(UserVisitPK userVisitPK, GetOrderPriorityForm form);
163
164    CommandResult getOrderPriorities(UserVisitPK userVisitPK, GetOrderPrioritiesForm form);
165
166    CommandResult setDefaultOrderPriority(UserVisitPK userVisitPK, SetDefaultOrderPriorityForm form);
167
168    CommandResult editOrderPriority(UserVisitPK userVisitPK, EditOrderPriorityForm form);
169
170    CommandResult deleteOrderPriority(UserVisitPK userVisitPK, DeleteOrderPriorityForm form);
171
172    // --------------------------------------------------------------------------------
173    //   Order Priority Descriptions
174    // --------------------------------------------------------------------------------
175
176    CommandResult createOrderPriorityDescription(UserVisitPK userVisitPK, CreateOrderPriorityDescriptionForm form);
177
178    CommandResult getOrderPriorityDescription(UserVisitPK userVisitPK, GetOrderPriorityDescriptionForm form);
179
180    CommandResult getOrderPriorityDescriptions(UserVisitPK userVisitPK, GetOrderPriorityDescriptionsForm form);
181
182    CommandResult editOrderPriorityDescription(UserVisitPK userVisitPK, EditOrderPriorityDescriptionForm form);
183
184    CommandResult deleteOrderPriorityDescription(UserVisitPK userVisitPK, DeleteOrderPriorityDescriptionForm form);
185
186    // --------------------------------------------------------------------------------
187    //   Order Adjustment Types
188    // --------------------------------------------------------------------------------
189
190    CommandResult createOrderAdjustmentType(UserVisitPK userVisitPK, CreateOrderAdjustmentTypeForm form);
191
192    CommandResult getOrderAdjustmentTypeChoices(UserVisitPK userVisitPK, GetOrderAdjustmentTypeChoicesForm form);
193
194    CommandResult getOrderAdjustmentType(UserVisitPK userVisitPK, GetOrderAdjustmentTypeForm form);
195
196    CommandResult getOrderAdjustmentTypes(UserVisitPK userVisitPK, GetOrderAdjustmentTypesForm form);
197
198    CommandResult setDefaultOrderAdjustmentType(UserVisitPK userVisitPK, SetDefaultOrderAdjustmentTypeForm form);
199
200    CommandResult editOrderAdjustmentType(UserVisitPK userVisitPK, EditOrderAdjustmentTypeForm form);
201
202    CommandResult deleteOrderAdjustmentType(UserVisitPK userVisitPK, DeleteOrderAdjustmentTypeForm form);
203
204    // --------------------------------------------------------------------------------
205    //   Order Adjustment Type Descriptions
206    // --------------------------------------------------------------------------------
207
208    CommandResult createOrderAdjustmentTypeDescription(UserVisitPK userVisitPK, CreateOrderAdjustmentTypeDescriptionForm form);
209
210    CommandResult getOrderAdjustmentTypeDescription(UserVisitPK userVisitPK, GetOrderAdjustmentTypeDescriptionForm form);
211
212    CommandResult getOrderAdjustmentTypeDescriptions(UserVisitPK userVisitPK, GetOrderAdjustmentTypeDescriptionsForm form);
213
214    CommandResult editOrderAdjustmentTypeDescription(UserVisitPK userVisitPK, EditOrderAdjustmentTypeDescriptionForm form);
215
216    CommandResult deleteOrderAdjustmentTypeDescription(UserVisitPK userVisitPK, DeleteOrderAdjustmentTypeDescriptionForm form);
217
218    // --------------------------------------------------------------------------------
219    //   Order Line Adjustment Types
220    // --------------------------------------------------------------------------------
221
222    CommandResult createOrderLineAdjustmentType(UserVisitPK userVisitPK, CreateOrderLineAdjustmentTypeForm form);
223
224    CommandResult getOrderLineAdjustmentTypeChoices(UserVisitPK userVisitPK, GetOrderLineAdjustmentTypeChoicesForm form);
225
226    CommandResult getOrderLineAdjustmentType(UserVisitPK userVisitPK, GetOrderLineAdjustmentTypeForm form);
227
228    CommandResult getOrderLineAdjustmentTypes(UserVisitPK userVisitPK, GetOrderLineAdjustmentTypesForm form);
229
230    CommandResult setDefaultOrderLineAdjustmentType(UserVisitPK userVisitPK, SetDefaultOrderLineAdjustmentTypeForm form);
231
232    CommandResult editOrderLineAdjustmentType(UserVisitPK userVisitPK, EditOrderLineAdjustmentTypeForm form);
233
234    CommandResult deleteOrderLineAdjustmentType(UserVisitPK userVisitPK, DeleteOrderLineAdjustmentTypeForm form);
235
236    // --------------------------------------------------------------------------------
237    //   Order Line Adjustment Type Descriptions
238    // --------------------------------------------------------------------------------
239
240    CommandResult createOrderLineAdjustmentTypeDescription(UserVisitPK userVisitPK, CreateOrderLineAdjustmentTypeDescriptionForm form);
241
242    CommandResult getOrderLineAdjustmentTypeDescription(UserVisitPK userVisitPK, GetOrderLineAdjustmentTypeDescriptionForm form);
243
244    CommandResult getOrderLineAdjustmentTypeDescriptions(UserVisitPK userVisitPK, GetOrderLineAdjustmentTypeDescriptionsForm form);
245
246    CommandResult editOrderLineAdjustmentTypeDescription(UserVisitPK userVisitPK, EditOrderLineAdjustmentTypeDescriptionForm form);
247
248    CommandResult deleteOrderLineAdjustmentTypeDescription(UserVisitPK userVisitPK, DeleteOrderLineAdjustmentTypeDescriptionForm form);
249
250}