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.purchase.common;
018
019import com.echothree.control.user.purchase.common.form.*;
020import com.echothree.control.user.purchase.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 PurchaseService
026        extends PurchaseForms {
027
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033
034    // --------------------------------------------------------------------------------
035    //   Purchase Orders
036    // --------------------------------------------------------------------------------
037
038    CommandResult<CreatePurchaseOrderResult> createPurchaseOrder(UserVisitPK userVisitPK, CreatePurchaseOrderForm form);
039
040    CommandResult<GetPurchaseOrderStatusChoicesResult> getPurchaseOrderStatusChoices(UserVisitPK userVisitPK, GetPurchaseOrderStatusChoicesForm form);
041
042    CommandResult<VoidResult> setPurchaseOrderStatus(UserVisitPK userVisitPK, SetPurchaseOrderStatusForm form);
043
044    // --------------------------------------------------------------------------------
045    //   Purchase Invoices
046    // --------------------------------------------------------------------------------
047
048    CommandResult<CreatePurchaseInvoiceResult> createPurchaseInvoice(UserVisitPK userVisitPK, CreatePurchaseInvoiceForm form);
049
050    CommandResult<GetPurchaseInvoiceStatusChoicesResult> getPurchaseInvoiceStatusChoices(UserVisitPK userVisitPK, GetPurchaseInvoiceStatusChoicesForm form);
051
052    CommandResult<VoidResult> setPurchaseInvoiceStatus(UserVisitPK userVisitPK, SetPurchaseInvoiceStatusForm form);
053
054    // --------------------------------------------------------------------------------
055    //   Purchase Invoice Lines
056    // --------------------------------------------------------------------------------
057    
058    CommandResult<CreatePurchaseInvoiceLineResult> createPurchaseInvoiceLine(UserVisitPK userVisitPK, CreatePurchaseInvoiceLineForm form);
059
060}