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.sales.common;
018
019import com.echothree.control.user.sales.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface SalesService
024        extends SalesForms {
025    
026    // -------------------------------------------------------------------------
027    //   Testing
028    // -------------------------------------------------------------------------
029    
030    String ping();
031    
032    // -------------------------------------------------------------------------
033    //   Sales Order Batches
034    // -------------------------------------------------------------------------
035    
036    CommandResult createSalesOrderBatch(UserVisitPK userVisitPK, CreateSalesOrderBatchForm form);
037    
038    CommandResult getSalesOrderBatch(UserVisitPK userVisitPK, GetSalesOrderBatchForm form);
039
040    CommandResult getSalesOrderBatches(UserVisitPK userVisitPK, GetSalesOrderBatchesForm form);
041    
042    CommandResult getSalesOrderBatchStatusChoices(UserVisitPK userVisitPK, GetSalesOrderBatchStatusChoicesForm form);
043    
044    CommandResult setSalesOrderBatchStatus(UserVisitPK userVisitPK, SetSalesOrderBatchStatusForm form);
045    
046    CommandResult editSalesOrderBatch(UserVisitPK userVisitPK, EditSalesOrderBatchForm form);
047
048    CommandResult deleteSalesOrderBatch(UserVisitPK userVisitPK, DeleteSalesOrderBatchForm form);
049
050    // -------------------------------------------------------------------------
051    //   Sales Orders
052    // -------------------------------------------------------------------------
053    
054    CommandResult createSalesOrder(UserVisitPK userVisitPK, CreateSalesOrderForm form);
055    
056    CommandResult getSalesOrderStatusChoices(UserVisitPK userVisitPK, GetSalesOrderStatusChoicesForm form);
057    
058    CommandResult setSalesOrderStatus(UserVisitPK userVisitPK, SetSalesOrderStatusForm form);
059    
060    // -------------------------------------------------------------------------
061    //   Sales Order Payment Preferences
062    // -------------------------------------------------------------------------
063    
064    CommandResult createSalesOrderPaymentPreference(UserVisitPK userVisitPK, CreateSalesOrderPaymentPreferenceForm form);
065    
066    // -------------------------------------------------------------------------
067    //   Sales Order Times
068    // -------------------------------------------------------------------------
069    
070    CommandResult createSalesOrderTime(UserVisitPK userVisitPK, CreateSalesOrderTimeForm form);
071    
072    CommandResult getSalesOrderTime(UserVisitPK userVisitPK, GetSalesOrderTimeForm form);
073
074    CommandResult getSalesOrderTimes(UserVisitPK userVisitPK, GetSalesOrderTimesForm form);
075    
076    CommandResult editSalesOrderTime(UserVisitPK userVisitPK, EditSalesOrderTimeForm form);
077
078    CommandResult deleteSalesOrderTime(UserVisitPK userVisitPK, DeleteSalesOrderTimeForm form);
079
080    // -------------------------------------------------------------------------
081    //   Sales Order Lines
082    // -------------------------------------------------------------------------
083    
084    CommandResult createSalesOrderLine(UserVisitPK userVisitPK, CreateSalesOrderLineForm form);
085    
086    // -------------------------------------------------------------------------
087    //   Sales Order Line Times
088    // -------------------------------------------------------------------------
089    
090    CommandResult createSalesOrderLineTime(UserVisitPK userVisitPK, CreateSalesOrderLineTimeForm form);
091    
092    CommandResult getSalesOrderLineTime(UserVisitPK userVisitPK, GetSalesOrderLineTimeForm form);
093
094    CommandResult getSalesOrderLineTimes(UserVisitPK userVisitPK, GetSalesOrderLineTimesForm form);
095    
096    CommandResult editSalesOrderLineTime(UserVisitPK userVisitPK, EditSalesOrderLineTimeForm form);
097
098    CommandResult deleteSalesOrderLineTime(UserVisitPK userVisitPK, DeleteSalesOrderLineTimeForm form);
099
100}