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