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.vendor.common;
018
019import com.echothree.control.user.vendor.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface VendorService
024        extends VendorForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // --------------------------------------------------------------------------------
033    //   Vendor Types
034    // --------------------------------------------------------------------------------
035    
036    CommandResult createVendorType(UserVisitPK userVisitPK, CreateVendorTypeForm form);
037    
038    CommandResult getVendorTypeChoices(UserVisitPK userVisitPK, GetVendorTypeChoicesForm form);
039    
040    CommandResult getVendorType(UserVisitPK userVisitPK, GetVendorTypeForm form);
041    
042    CommandResult getVendorTypes(UserVisitPK userVisitPK, GetVendorTypesForm form);
043    
044    CommandResult setDefaultVendorType(UserVisitPK userVisitPK, SetDefaultVendorTypeForm form);
045    
046    CommandResult editVendorType(UserVisitPK userVisitPK, EditVendorTypeForm form);
047    
048    CommandResult deleteVendorType(UserVisitPK userVisitPK, DeleteVendorTypeForm form);
049    
050    // --------------------------------------------------------------------------------
051    //   Vendor Type Descriptions
052    // --------------------------------------------------------------------------------
053    
054    CommandResult createVendorTypeDescription(UserVisitPK userVisitPK, CreateVendorTypeDescriptionForm form);
055    
056    CommandResult getVendorTypeDescription(UserVisitPK userVisitPK, GetVendorTypeDescriptionForm form);
057    
058    CommandResult getVendorTypeDescriptions(UserVisitPK userVisitPK, GetVendorTypeDescriptionsForm form);
059    
060    CommandResult editVendorTypeDescription(UserVisitPK userVisitPK, EditVendorTypeDescriptionForm form);
061    
062    CommandResult deleteVendorTypeDescription(UserVisitPK userVisitPK, DeleteVendorTypeDescriptionForm form);
063    
064    // -------------------------------------------------------------------------
065    //   Vendors
066    // -------------------------------------------------------------------------
067
068    CommandResult getVendor(UserVisitPK userVisitPK, GetVendorForm form);
069
070    CommandResult getVendors(UserVisitPK userVisitPK, GetVendorsForm form);
071
072    CommandResult editVendor(UserVisitPK userVisitPK, EditVendorForm form);
073    
074    // -------------------------------------------------------------------------
075    //   Vendor Items
076    // -------------------------------------------------------------------------
077    
078    CommandResult createVendorItem(UserVisitPK userVisitPK, CreateVendorItemForm form);
079    
080    CommandResult getVendorItem(UserVisitPK userVisitPK, GetVendorItemForm form);
081
082    CommandResult getVendorItems(UserVisitPK userVisitPK, GetVendorItemsForm form);
083
084    CommandResult getVendorItemStatusChoices(UserVisitPK userVisitPK, GetVendorItemStatusChoicesForm form);
085
086    CommandResult setVendorItemStatus(UserVisitPK userVisitPK, SetVendorItemStatusForm form);
087
088    CommandResult editVendorItem(UserVisitPK userVisitPK, EditVendorItemForm form);
089    
090    CommandResult deleteVendorItem(UserVisitPK userVisitPK, DeleteVendorItemForm form);
091    
092    // -------------------------------------------------------------------------
093    //   Vendor Item Costs
094    // -------------------------------------------------------------------------
095    
096    CommandResult createVendorItemCost(UserVisitPK userVisitPK, CreateVendorItemCostForm form);
097    
098    CommandResult getVendorItemCost(UserVisitPK userVisitPK, GetVendorItemCostForm form);
099    
100    CommandResult getVendorItemCosts(UserVisitPK userVisitPK, GetVendorItemCostsForm form);
101    
102    CommandResult editVendorItemCost(UserVisitPK userVisitPK, EditVendorItemCostForm form);
103    
104    CommandResult deleteVendorItemCost(UserVisitPK userVisitPK, DeleteVendorItemCostForm form);
105    
106    // --------------------------------------------------------------------------------
107    //   Item Purchasing Categories
108    // --------------------------------------------------------------------------------
109    
110    CommandResult createItemPurchasingCategory(UserVisitPK userVisitPK, CreateItemPurchasingCategoryForm form);
111    
112    CommandResult getItemPurchasingCategoryChoices(UserVisitPK userVisitPK, GetItemPurchasingCategoryChoicesForm form);
113    
114    CommandResult getItemPurchasingCategory(UserVisitPK userVisitPK, GetItemPurchasingCategoryForm form);
115    
116    CommandResult getItemPurchasingCategories(UserVisitPK userVisitPK, GetItemPurchasingCategoriesForm form);
117    
118    CommandResult setDefaultItemPurchasingCategory(UserVisitPK userVisitPK, SetDefaultItemPurchasingCategoryForm form);
119    
120    CommandResult editItemPurchasingCategory(UserVisitPK userVisitPK, EditItemPurchasingCategoryForm form);
121    
122    CommandResult deleteItemPurchasingCategory(UserVisitPK userVisitPK, DeleteItemPurchasingCategoryForm form);
123    
124    // --------------------------------------------------------------------------------
125    //   Item Vendor Category Descriptions
126    // --------------------------------------------------------------------------------
127    
128    CommandResult createItemPurchasingCategoryDescription(UserVisitPK userVisitPK, CreateItemPurchasingCategoryDescriptionForm form);
129    
130    CommandResult getItemPurchasingCategoryDescription(UserVisitPK userVisitPK, GetItemPurchasingCategoryDescriptionForm form);
131    
132    CommandResult getItemPurchasingCategoryDescriptions(UserVisitPK userVisitPK, GetItemPurchasingCategoryDescriptionsForm form);
133    
134    CommandResult editItemPurchasingCategoryDescription(UserVisitPK userVisitPK, EditItemPurchasingCategoryDescriptionForm form);
135    
136    CommandResult deleteItemPurchasingCategoryDescription(UserVisitPK userVisitPK, DeleteItemPurchasingCategoryDescriptionForm form);
137    
138}