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