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.warehouse.common;
018
019import com.echothree.control.user.filter.common.form.CreateFilterKindDescriptionForm;
020import com.echothree.control.user.filter.common.form.CreateFilterKindForm;
021import com.echothree.control.user.filter.common.form.DeleteFilterKindDescriptionForm;
022import com.echothree.control.user.filter.common.form.DeleteFilterKindForm;
023import com.echothree.control.user.filter.common.form.EditFilterKindDescriptionForm;
024import com.echothree.control.user.filter.common.form.EditFilterKindForm;
025import com.echothree.control.user.filter.common.form.GetFilterKindChoicesForm;
026import com.echothree.control.user.filter.common.form.GetFilterKindDescriptionForm;
027import com.echothree.control.user.filter.common.form.GetFilterKindDescriptionsForm;
028import com.echothree.control.user.filter.common.form.GetFilterKindForm;
029import com.echothree.control.user.filter.common.form.GetFilterKindsForm;
030import com.echothree.control.user.filter.common.form.SetDefaultFilterKindForm;
031import com.echothree.control.user.warehouse.common.form.*;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.command.CommandResult;
034
035public interface WarehouseService
036        extends WarehouseForms {
037    
038    // -------------------------------------------------------------------------
039    //   Testing
040    // -------------------------------------------------------------------------
041    
042    String ping();
043    
044    // -------------------------------------------------------------------------
045    //   Location Use Types
046    // -------------------------------------------------------------------------
047    
048    CommandResult createLocationUseType(UserVisitPK userVisitPK, CreateLocationUseTypeForm form);
049
050    CommandResult getLocationUseTypes(UserVisitPK userVisitPK, GetLocationUseTypesForm form);
051
052    CommandResult getLocationUseType(UserVisitPK userVisitPK, GetLocationUseTypeForm form);
053
054    CommandResult getLocationUseTypeChoices(UserVisitPK userVisitPK, GetLocationUseTypeChoicesForm form);
055    
056    // -------------------------------------------------------------------------
057    //   Location Use Type Descriptions
058    // -------------------------------------------------------------------------
059    
060    CommandResult createLocationUseTypeDescription(UserVisitPK userVisitPK, CreateLocationUseTypeDescriptionForm form);
061
062    // -------------------------------------------------------------------------
063    //   WarehouseT ypes
064    // -------------------------------------------------------------------------
065
066    CommandResult createWarehouseType(UserVisitPK userVisitPK, CreateWarehouseTypeForm form);
067
068    CommandResult getWarehouseTypes(UserVisitPK userVisitPK, GetWarehouseTypesForm form);
069
070    CommandResult getWarehouseType(UserVisitPK userVisitPK, GetWarehouseTypeForm form);
071
072    CommandResult getWarehouseTypeChoices(UserVisitPK userVisitPK, GetWarehouseTypeChoicesForm form);
073
074    CommandResult setDefaultWarehouseType(UserVisitPK userVisitPK, SetDefaultWarehouseTypeForm form);
075
076    CommandResult editWarehouseType(UserVisitPK userVisitPK, EditWarehouseTypeForm form);
077
078    CommandResult deleteWarehouseType(UserVisitPK userVisitPK, DeleteWarehouseTypeForm form);
079
080    // -------------------------------------------------------------------------
081    //   Warehouse Type Descriptions
082    // -------------------------------------------------------------------------
083
084    CommandResult createWarehouseTypeDescription(UserVisitPK userVisitPK, CreateWarehouseTypeDescriptionForm form);
085
086    CommandResult getWarehouseTypeDescriptions(UserVisitPK userVisitPK, GetWarehouseTypeDescriptionsForm form);
087
088    CommandResult getWarehouseTypeDescription(UserVisitPK userVisitPK, GetWarehouseTypeDescriptionForm form);
089
090    CommandResult editWarehouseTypeDescription(UserVisitPK userVisitPK, EditWarehouseTypeDescriptionForm form);
091
092    CommandResult deleteWarehouseTypeDescription(UserVisitPK userVisitPK, DeleteWarehouseTypeDescriptionForm form);
093
094    // -------------------------------------------------------------------------
095    //   Warehouses
096    // -------------------------------------------------------------------------
097    
098    CommandResult createWarehouse(UserVisitPK userVisitPK, CreateWarehouseForm form);
099    
100    CommandResult getWarehouses(UserVisitPK userVisitPK, GetWarehousesForm form);
101    
102    CommandResult getWarehouse(UserVisitPK userVisitPK, GetWarehouseForm form);
103    
104    CommandResult getWarehouseChoices(UserVisitPK userVisitPK, GetWarehouseChoicesForm form);
105    
106    CommandResult setDefaultWarehouse(UserVisitPK userVisitPK, SetDefaultWarehouseForm form);
107    
108    CommandResult editWarehouse(UserVisitPK userVisitPK, EditWarehouseForm form);
109    
110    CommandResult deleteWarehouse(UserVisitPK userVisitPK, DeleteWarehouseForm form);
111    
112    // -------------------------------------------------------------------------
113    //   Location Types
114    // -------------------------------------------------------------------------
115    
116    CommandResult createLocationType(UserVisitPK userVisitPK, CreateLocationTypeForm form);
117    
118    CommandResult getLocationTypes(UserVisitPK userVisitPK, GetLocationTypesForm form);
119    
120    CommandResult getLocationType(UserVisitPK userVisitPK, GetLocationTypeForm form);
121    
122    CommandResult getLocationTypeChoices(UserVisitPK userVisitPK, GetLocationTypeChoicesForm form);
123    
124    CommandResult setDefaultLocationType(UserVisitPK userVisitPK, SetDefaultLocationTypeForm form);
125    
126    CommandResult editLocationType(UserVisitPK userVisitPK, EditLocationTypeForm form);
127    
128    CommandResult deleteLocationType(UserVisitPK userVisitPK, DeleteLocationTypeForm form);
129    
130    // -------------------------------------------------------------------------
131    //   Location Type Descriptions
132    // -------------------------------------------------------------------------
133    
134    CommandResult createLocationTypeDescription(UserVisitPK userVisitPK, CreateLocationTypeDescriptionForm form);
135    
136    CommandResult getLocationTypeDescriptions(UserVisitPK userVisitPK, GetLocationTypeDescriptionsForm form);
137    
138    CommandResult editLocationTypeDescription(UserVisitPK userVisitPK, EditLocationTypeDescriptionForm form);
139    
140    CommandResult deleteLocationTypeDescription(UserVisitPK userVisitPK, DeleteLocationTypeDescriptionForm form);
141    
142    // -------------------------------------------------------------------------
143    //   Location Name Elements
144    // -------------------------------------------------------------------------
145    
146    CommandResult createLocationNameElement(UserVisitPK userVisitPK, CreateLocationNameElementForm form);
147    
148    CommandResult getLocationNameElements(UserVisitPK userVisitPK, GetLocationNameElementsForm form);
149
150    CommandResult getLocationNameElement(UserVisitPK userVisitPK, GetLocationNameElementForm form);
151
152    CommandResult editLocationNameElement(UserVisitPK userVisitPK, EditLocationNameElementForm form);
153    
154    CommandResult deleteLocationNameElement(UserVisitPK userVisitPK, DeleteLocationNameElementForm form);
155    
156    // -------------------------------------------------------------------------
157    //   Location Name Element Descriptions
158    // -------------------------------------------------------------------------
159    
160    CommandResult createLocationNameElementDescription(UserVisitPK userVisitPK, CreateLocationNameElementDescriptionForm form);
161    
162    CommandResult getLocationNameElementDescriptions(UserVisitPK userVisitPK, GetLocationNameElementDescriptionsForm form);
163    
164    CommandResult editLocationNameElementDescription(UserVisitPK userVisitPK, EditLocationNameElementDescriptionForm form);
165    
166    CommandResult deleteLocationNameElementDescription(UserVisitPK userVisitPK, DeleteLocationNameElementDescriptionForm form);
167    
168    // -------------------------------------------------------------------------
169    //   Locations
170    // -------------------------------------------------------------------------
171    
172    CommandResult createLocation(UserVisitPK userVisitPK, CreateLocationForm form);
173    
174    CommandResult getLocations(UserVisitPK userVisitPK, GetLocationsForm form);
175    
176    CommandResult getLocation(UserVisitPK userVisitPK, GetLocationForm form);
177    
178    CommandResult getLocationChoices(UserVisitPK userVisitPK, GetLocationChoicesForm form);
179    
180    CommandResult getLocationStatusChoices(UserVisitPK userVisitPK, GetLocationStatusChoicesForm form);
181    
182    CommandResult setLocationStatus(UserVisitPK userVisitPK, SetLocationStatusForm form);
183    
184    CommandResult editLocation(UserVisitPK userVisitPK, EditLocationForm form);
185    
186    CommandResult deleteLocation(UserVisitPK userVisitPK, DeleteLocationForm form);
187    
188    // -------------------------------------------------------------------------
189    //   Location Descriptions
190    // -------------------------------------------------------------------------
191    
192    CommandResult createLocationDescription(UserVisitPK userVisitPK, CreateLocationDescriptionForm form);
193    
194    CommandResult getLocationDescriptions(UserVisitPK userVisitPK, GetLocationDescriptionsForm form);
195    
196    CommandResult editLocationDescription(UserVisitPK userVisitPK, EditLocationDescriptionForm form);
197    
198    CommandResult deleteLocationDescription(UserVisitPK userVisitPK, DeleteLocationDescriptionForm form);
199    
200    // --------------------------------------------------------------------------------
201    //   Location Capacities
202    // --------------------------------------------------------------------------------
203    
204    CommandResult createLocationCapacity(UserVisitPK userVisitPK, CreateLocationCapacityForm form);
205    
206    CommandResult getLocationCapacities(UserVisitPK userVisitPK, GetLocationCapacitiesForm form);
207    
208    CommandResult editLocationCapacity(UserVisitPK userVisitPK, EditLocationCapacityForm form);
209    
210    CommandResult deleteLocationCapacity(UserVisitPK userVisitPK, DeleteLocationCapacityForm form);
211    
212    // --------------------------------------------------------------------------------
213    //   Location Volumes
214    // --------------------------------------------------------------------------------
215    
216    CommandResult createLocationVolume(UserVisitPK userVisitPK, CreateLocationVolumeForm form);
217    
218    CommandResult editLocationVolume(UserVisitPK userVisitPK, EditLocationVolumeForm form);
219    
220    CommandResult deleteLocationVolume(UserVisitPK userVisitPK, DeleteLocationVolumeForm form);
221    
222}