Package com.clover.sdk.v3.order

Class OrderV31Connector

java.lang.Object

com.clover.sdk.v1.ServiceConnector<IOrderServiceV3_1>

com.clover.sdk.v3.order.OrderV31Connector

All Implemented Interfaces:

ServiceConnection

Direct Known Subclasses:

OrderConnector

public class OrderV31Connector
extends ServiceConnector<IOrderServiceV3_1>

Service connector for IOrderServiceV3_1. Please see that class for documentation on the RPC methods. Developers should use OrderConnector instead of using this class directly.

See Also:

OrderConnector, IOrderServiceV3_1, ServiceConnector, Order, LineItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OrderV31Connector.OnOrderUpdateListener	Interface used to allow application to be notified of order updates.
static interface	OrderV31Connector.OnOrderUpdateListener2

Nested classes/interfaces inherited from class com.clover.sdk.v1.ServiceConnector

ServiceConnector.Callback<T>, ServiceConnector.OnServiceConnectedListener, ServiceConnector.ServiceCallable<S,T>, ServiceConnector.ServiceRunnable<S>

Field Summary

Fields inherited from class com.clover.sdk.v1.ServiceConnector

mAccount, mClient, mConnected, mContext, mHandler, mService

Constructor Summary

Constructors

Constructor	Description
OrderV31Connector(Context context, Account account, ServiceConnector.OnServiceConnectedListener client)	Constructs a new OrderConnector object.

Method Summary

Modifier and Type	Method	Description
Authorization	addAuthorization(String orderId, Authorization authorization)	Not available to non-Clover apps.
Order	addBatchLineItemDiscounts(String orderId, List<String> lineItemIds, List<Discount> discounts)
Order	addBatchLineItemModification(String orderId, List<String> lineItemIds, Modifier modifier, int quantity)
Credit	addCredit(String orderId, Credit credit)	Not available to non-Clover apps.
CreditRefund	addCreditRefund(String orderId, CreditRefund creditRefund)	Not available to non-Clover apps.
LineItem	addCustomLineItem(String orderId, LineItem lineItem, boolean isTaxable)
Order	addDiscount(String orderId, Discount discount)
Discount	addDiscount2(String orderId, Discount discount)
LineItem	addFixedPriceLineItem(String orderId, String itemId, String binName, String userData)
List<LineItem>	addFixedPriceLineItems(String orderId, String itemId, String binName, String userData, int numItems)
Order	addLineItemDiscount(String orderId, String lineItemId, Discount discount)
Discount	addLineItemDiscount2(String orderId, String lineItemId, Discount discount)
Order	addLineItemModification(String orderId, String lineItemId, Modifier modifier)
Order	addLPMPayment(String orderId, Payment payment)	Not available to non-Clover apps.
void	addOnOrderChangedListener(OrderV31Connector.OnOrderUpdateListener listener)
void	addOnOrderChangedListener(OrderV31Connector.OnOrderUpdateListener2 listener)
Order	addOrderFee(String orderId, String orderFeeId)
Order	addPayment(String orderId, Payment payment, List<LineItem> lineItems)	Deprecated. Use addPayment2(java.lang.String, com.clover.sdk.v3.payments.Payment, java.util.List<com.clover.sdk.v3.order.LineItem>).
Order	addPayment2(String orderId, Payment payment, List<LineItem> lineItems)	Not available to non-Clover apps.
LineItem	addPerUnitLineItem(String orderId, String itemId, int unitQuantity, String binName, String userData)
List<LineItem>	addPerUnitLineItems(String orderId, String itemId, int unitQuantity, String binName, String userData, int numItems)
Order	addPreAuth(String orderId, Payment preAuth)
Order	addPrintGroup(String orderId, PrintGroup printGroup)
Refund	addRefund(String orderId, Refund refund)	Not available to non-Clover apps.
Refund	addRefundOffline(String orderId, Refund refund)	Not available to non-Clover apps.
Order	addServiceCharge(String orderId, String serviceChargeId)
Order	addServiceCharge2(String orderId, String serviceChargeId, boolean isAutoApplied)	Adds service charge to the order
Order	addTip(String orderId, String paymentId, long amount, boolean online)	Not available to non-Clover apps.
Order	addTipWithAdditionalCharges(String orderId, String paymentId, long amount, List<AdditionalChargeAmount> additionalChargeAmounts, boolean online)	Not available to non-Clover apps.
LineItem	addVariablePriceLineItem(String orderId, String itemId, long price, String binName, String userData)
List<LineItem>	addVariablePriceLineItems(String orderId, String itemId, long price, String binName, String userData, int numItems)
Order	captureAuthorization(String orderId, Authorization authorization)	Not available to non-Clover apps.
Order	capturePreAuth(String orderId, Payment preAuth, List<LineItem> lineItems)	Deprecated.
Order	capturePreAuthorization(String orderId, Payment preAuth, Payment closingPayment, List<LineItem> lineItems)	This method is used to capture a preauthorized payment.
Order	cleanUpPreAuthAfterTransaction(String orderId, VoidReason voidReason)
List<LineItem>	copyLineItems(String sourceOrderId, String destinationOrderId, List<String> srclineItemIds)	Deprecated.
Map<String,List<LineItem>>	createLineItemsFrom(String sourceOrderId, String destinationOrderId, List<String> srclineItemIds)
Map<String,List<LineItem>>	createLineItemsFrom2(String sourceOrderId, String destinationOrderId, List<String> srclineItemIds, boolean copyPrinted, boolean broadcastLineItems)
Order	createOrder(Order order)
Order	deleteCredit(String orderId, String creditId)
Order	deleteCreditRefund(String orderId, String creditRefundId)
Order	deleteDiscounts(String orderId, List<String> discountIds)
Order	deleteLineItemDiscounts(String orderId, String lineItemId, List<String> discountIds)
Order	deleteLineItemModifications(String orderId, String lineItemId, List<String> modificationIds)
Order	deleteLineItems(String orderId, List<String> lineItemIds)
Order	deleteLineItems2(String orderId, List<String> lineItemIds, ClientEventType clientEventType, String approvedByEmployeeId)
Order	deleteLineItemsWithReason(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType)	Deprecated. you can use deleteLineItems2(java.lang.String, java.util.List<java.lang.String>, com.clover.sdk.v3.order.ClientEventType, java.lang.String)
Order	deleteLineItemsWithReason2(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType, String approvedByEmployeeId)
boolean	deleteOrder(String orderId)
boolean	deleteOrder2(String orderId, boolean allowDeleteIfLineItemPrinted)
boolean	deleteOrder3(String orderId, boolean deleteOnline, boolean allowDeleteIfLineItemPrinted, boolean allowDeleteIfNoEmployeePermission)	Not available to non-Clover apps.
Order	deleteOrderFee(String orderId, String orderFeeLineItemId)
boolean	deleteOrderOnline(String orderId)
boolean	deleteOrderOnline2(String orderId, boolean usePermissionForOrderDeletions)	Deprecated. Use deleteOrder3(java.lang.String, boolean, boolean, boolean).
Order	deletePreAuth(String orderId, String paymentId, VoidReason voidReason, VoidExtraData voidExtraData)
Order	deleteRefund(String orderId, String refundId)
Order	deleteServiceCharge(String orderId, String serviceChargeId)
void	disconnect()
LineItem	exchangeItem(String orderId, String oldLineItemId, String itemId, String binName, String userData)
boolean	fire(String orderId)
boolean	fire2(String orderId, boolean requireAllItems)
boolean	fireLineItems(String orderId, List<LineItem> lineItemList)	Send all line items added in the List to the kitchen or order printer.
boolean	firePrintGroups(String orderId, List<String> printGroupIds, boolean requireAllItems)
List<String>	getLineItemsToFire(String orderId)
Order	getOrder(String orderId)
List<Order>	getOrders(List<String> orderIds)
List<Payment>	getPendingPayments()
protected String	getServiceIntentAction()
protected String	getServiceIntentPackage()	The package which hosts the service to connect to.
protected int	getServiceIntentVersion()	Connectors that are versioned include a version number in the action returned by ServiceConnector.getServiceIntentAction() instead of using this mechanism.
protected IOrderServiceV3_1	getServiceInterface(IBinder iBinder)
protected void	notifyServiceConnected(ServiceConnector.OnServiceConnectedListener client)
Refund	partialRefundV3(String orderId, Refund refund, boolean tipIncluded)
Payment	pay(String orderId, PaymentRequest paymentRequest, boolean isAllowOffline, String note)	Not available to non-Clover apps.
Order	queueVoid(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map<String,String> passThroughExtras, VoidReason reason, VoidExtraData voidExtraData, String source)	Not available to non-Clover apps.
boolean	refire(String orderId)
Refund	refund(String orderId, Refund refund)	Not available to non-Clover apps.
Refund	refund2(String orderId, Refund refund, Map<String,String> passThroughExtras)	Not available to non-Clover apps.
void	removeOnOrderChangedListener(OrderV31Connector.OnOrderUpdateListener listener)
void	removeOnOrderChangedListener(OrderV31Connector.OnOrderUpdateListener2 listener)
Order	removePayment(String orderId, String paymentId)	Not available to non-Clover apps.
Order	setLineItemNote(String orderId, String lineItemId, String note)
List<LineItem>	splitLineItems(String orderId, List<String> lineItemIds, List<String> binNames)
List<LineItem>	updateLineItems(String orderId, List<LineItem> lineItems)
void	updateOnlineOrderState(String orderId, OrderState orderState, Reason reason)
Order	updateOrder(Order order)
Payment	updatePayment(String orderId, Payment payment)	Not available to non-Clover apps.
Payment	updatePaymentStatus(String orderId, Payment payment)	Not available to non-Clover apps.
Order	updatePrintGroup(String orderId, PrintGroup printGroup)
CreditRefund	vaultedCreditRefund(String orderId, String creditId)	Not available to non-Clover apps.
Order	voidPayment(String orderId, String paymentId)	Deprecated. Use voidPayment2(java.lang.String, java.lang.String, java.lang.String, com.clover.sdk.v3.order.VoidReason, java.lang.String).
Order	voidPayment2(String orderId, String paymentId, String iccContainer, VoidReason reason, String source)	Not available to non-Clover apps.
Order	voidPayment3(String orderId, String paymentId, String iccContainer, Map<String,String> passThroughExtras, VoidReason reason, String source)	Not available to non-Clover apps.
Order	voidPaymentCardPresent(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, VoidReason reason, String source)	Not available to non-Clover apps.
Order	voidPaymentCardPresent2(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map<String,String> passThroughExtras, VoidReason reason, String source)	Not available to non-Clover apps.
Order	voidPaymentCardPresent3(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map<String,String> passThroughExtras, VoidReason reason, VoidExtraData voidExtraData, String source)	Not available to non-Clover apps.
Order	voidPaymentWithCard(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, VoidReason reason, String source)	Not available to non-Clover apps.
Order	voidPreAuth(String orderId, String preAuthId, String iccContainer, VoidReason voidReason, String source)
Order	voidPreAuthOnline(String orderId, String preAuthId, String iccContainer, VoidReason voidReason, String source)
Refund	voidRefund(String orderId, Refund refund)
Refund	voidRefundOffline(String orderId, Refund refund)

Methods inherited from class com.clover.sdk.v1.ServiceConnector

connect, execute, execute, execute, execute, getService, getStartIntent, isConnected, isInstalled, notifyServiceDisconnected, onServiceConnected, onServiceDisconnected, postResults, throwOnFailure, waitForConnection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.content.ServiceConnection

onBindingDied, onNullBinding

Constructor Detail

OrderV31Connector

public OrderV31Connector(Context context,
                         Account account,
                         ServiceConnector.OnServiceConnectedListener client)

Constructs a new OrderConnector object.

Parameters:

context - the Context object, required for establishing a connection to the service.

account - the Account to use with the service.

client - an optional object implementing the OnServiceConnectedListener interface, for receiving connection notifications from the service.

Method Detail

getServiceIntentAction

protected String getServiceIntentAction()

Specified by:

getServiceIntentAction in class ServiceConnector<IOrderServiceV3_1>

getServiceIntentPackage

protected String getServiceIntentPackage()

Description copied from class: ServiceConnector

The package which hosts the service to connect to. Returning null is OK for api target < 21. Once you try to build with 21 or higher returning null will cause an illegal argument exception

Overrides:

getServiceIntentPackage in class ServiceConnector<IOrderServiceV3_1>

getServiceIntentVersion

protected int getServiceIntentVersion()

Description copied from class: ServiceConnector

Connectors that are versioned include a version number in the action returned by ServiceConnector.getServiceIntentAction() instead of using this mechanism.

Overrides:

getServiceIntentVersion in class ServiceConnector<IOrderServiceV3_1>

getServiceInterface

protected IOrderServiceV3_1 getServiceInterface(IBinder iBinder)

Specified by:

getServiceInterface in class ServiceConnector<IOrderServiceV3_1>

notifyServiceConnected

protected void notifyServiceConnected(ServiceConnector.OnServiceConnectedListener client)

Overrides:

notifyServiceConnected in class ServiceConnector<IOrderServiceV3_1>

disconnect

public void disconnect()

Overrides:

disconnect in class ServiceConnector<IOrderServiceV3_1>

getOrder

public Order getOrder(String orderId)
               throws RemoteException,
                      ClientException,
                      ServiceException,
                      BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

getOrders

public List<Order> getOrders(List<String> orderIds)
                      throws RemoteException,
                             ClientException,
                             ServiceException,
                             BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

getPendingPayments

public List<Payment> getPendingPayments()
                                 throws RemoteException,
                                        ClientException,
                                        ServiceException,
                                        BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

createOrder

public Order createOrder(Order order)
                  throws RemoteException,
                         ClientException,
                         ServiceException,
                         BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

updateOrder

public Order updateOrder(Order order)
                  throws RemoteException,
                         ClientException,
                         ServiceException,
                         BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteOrder

public boolean deleteOrder(String orderId)
                    throws RemoteException,
                           ClientException,
                           ServiceException,
                           BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteOrderOnline

public boolean deleteOrderOnline(String orderId)
                          throws RemoteException,
                                 ClientException,
                                 ServiceException,
                                 BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addServiceCharge

public Order addServiceCharge(String orderId,
                              String serviceChargeId)
                       throws RemoteException,
                              ClientException,
                              ServiceException,
                              BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteServiceCharge

public Order deleteServiceCharge(String orderId,
                                 String serviceChargeId)
                          throws RemoteException,
                                 ClientException,
                                 ServiceException,
                                 BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addFixedPriceLineItem

public LineItem addFixedPriceLineItem(String orderId,
                                      String itemId,
                                      String binName,
                                      String userData)
                               throws RemoteException,
                                      ClientException,
                                      ServiceException,
                                      BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addPerUnitLineItem

public LineItem addPerUnitLineItem(String orderId,
                                   String itemId,
                                   int unitQuantity,
                                   String binName,
                                   String userData)
                            throws RemoteException,
                                   ClientException,
                                   ServiceException,
                                   BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addVariablePriceLineItem

public LineItem addVariablePriceLineItem(String orderId,
                                         String itemId,
                                         long price,
                                         String binName,
                                         String userData)
                                  throws RemoteException,
                                         ClientException,
                                         ServiceException,
                                         BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addFixedPriceLineItems

public List<LineItem> addFixedPriceLineItems(String orderId,
                                             String itemId,
                                             String binName,
                                             String userData,
                                             int numItems)
                                      throws RemoteException,
                                             ClientException,
                                             ServiceException,
                                             BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addPerUnitLineItems

public List<LineItem> addPerUnitLineItems(String orderId,
                                          String itemId,
                                          int unitQuantity,
                                          String binName,
                                          String userData,
                                          int numItems)
                                   throws RemoteException,
                                          ClientException,
                                          ServiceException,
                                          BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addVariablePriceLineItems

public List<LineItem> addVariablePriceLineItems(String orderId,
                                                String itemId,
                                                long price,
                                                String binName,
                                                String userData,
                                                int numItems)
                                         throws RemoteException,
                                                ClientException,
                                                ServiceException,
                                                BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addCustomLineItem

public LineItem addCustomLineItem(String orderId,
                                  LineItem lineItem,
                                  boolean isTaxable)
                           throws RemoteException,
                                  ClientException,
                                  ServiceException,
                                  BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

splitLineItems

public List<LineItem> splitLineItems(String orderId,
                                     List<String> lineItemIds,
                                     List<String> binNames)
                              throws RemoteException,
                                     ClientException,
                                     ServiceException,
                                     BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

updateLineItems

public List<LineItem> updateLineItems(String orderId,
                                      List<LineItem> lineItems)
                               throws RemoteException,
                                      ClientException,
                                      ServiceException,
                                      BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteLineItems

public Order deleteLineItems(String orderId,
                             List<String> lineItemIds)
                      throws RemoteException,
                             ClientException,
                             ServiceException,
                             BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteLineItems2

public Order deleteLineItems2(String orderId,
                              List<String> lineItemIds,
                              ClientEventType clientEventType,
                              String approvedByEmployeeId)
                       throws RemoteException,
                              ClientException,
                              ServiceException,
                              BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteLineItemsWithReason2

public Order deleteLineItemsWithReason2(String orderId,
                                        List<String> lineItemIds,
                                        String reason,
                                        ClientEventType clientEventType,
                                        String approvedByEmployeeId)
                                 throws RemoteException,
                                        ClientException,
                                        ServiceException,
                                        BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteLineItemsWithReason

@Deprecated
public Order deleteLineItemsWithReason(String orderId,
                                       List<String> lineItemIds,
                                       String reason,
                                       ClientEventType clientEventType)
                                throws RemoteException,
                                       ClientException,
                                       ServiceException,
                                       BindingException

Deprecated.

you can use deleteLineItems2(java.lang.String, java.util.List<java.lang.String>, com.clover.sdk.v3.order.ClientEventType, java.lang.String)

This method is being deprecated as there was no real usage of the "reason" parameter. Note that there is no direct replacement method.

Throws:

RemoteException

ClientException

ServiceException

BindingException

copyLineItems

@Deprecated
public List<LineItem> copyLineItems(String sourceOrderId,
                                    String destinationOrderId,
                                    List<String> srclineItemIds)
                             throws RemoteException,
                                    ClientException,
                                    ServiceException,
                                    BindingException

Deprecated.

Throws:

RemoteException

ClientException

ServiceException

BindingException

createLineItemsFrom

public Map<String,List<LineItem>> createLineItemsFrom(String sourceOrderId,
                                                            String destinationOrderId,
                                                            List<String> srclineItemIds)
                                                     throws RemoteException,
                                                            ClientException,
                                                            ServiceException,
                                                            BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

setLineItemNote

public Order setLineItemNote(String orderId,
                             String lineItemId,
                             String note)
                      throws RemoteException,
                             ClientException,
                             ServiceException,
                             BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addLineItemModification

public Order addLineItemModification(String orderId,
                                     String lineItemId,
                                     Modifier modifier)
                              throws RemoteException,
                                     ClientException,
                                     ServiceException,
                                     BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addBatchLineItemModification

public Order addBatchLineItemModification(String orderId,
                                          List<String> lineItemIds,
                                          Modifier modifier,
                                          int quantity)
                                   throws RemoteException,
                                          ClientException,
                                          ServiceException,
                                          BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteLineItemModifications

public Order deleteLineItemModifications(String orderId,
                                         String lineItemId,
                                         List<String> modificationIds)
                                  throws RemoteException,
                                         ClientException,
                                         ServiceException,
                                         BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

exchangeItem

public LineItem exchangeItem(String orderId,
                             String oldLineItemId,
                             String itemId,
                             String binName,
                             String userData)
                      throws RemoteException,
                             ClientException,
                             ServiceException,
                             BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addPrintGroup

public Order addPrintGroup(String orderId,
                           PrintGroup printGroup)
                    throws RemoteException,
                           ClientException,
                           ServiceException,
                           BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

updatePrintGroup

public Order updatePrintGroup(String orderId,
                              PrintGroup printGroup)
                       throws RemoteException,
                              ClientException,
                              ServiceException,
                              BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addDiscount

public Order addDiscount(String orderId,
                         Discount discount)
                  throws RemoteException,
                         ClientException,
                         ServiceException,
                         BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addDiscount2

public Discount addDiscount2(String orderId,
                             Discount discount)
                      throws RemoteException,
                             ClientException,
                             ServiceException,
                             BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteDiscounts

public Order deleteDiscounts(String orderId,
                             List<String> discountIds)
                      throws RemoteException,
                             ClientException,
                             ServiceException,
                             BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addLineItemDiscount

public Order addLineItemDiscount(String orderId,
                                 String lineItemId,
                                 Discount discount)
                          throws RemoteException,
                                 ClientException,
                                 ServiceException,
                                 BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addLineItemDiscount2

public Discount addLineItemDiscount2(String orderId,
                                     String lineItemId,
                                     Discount discount)
                              throws RemoteException,
                                     ClientException,
                                     ServiceException,
                                     BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addBatchLineItemDiscounts

public Order addBatchLineItemDiscounts(String orderId,
                                       List<String> lineItemIds,
                                       List<Discount> discounts)
                                throws RemoteException,
                                       ClientException,
                                       ServiceException,
                                       BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteLineItemDiscounts

public Order deleteLineItemDiscounts(String orderId,
                                     String lineItemId,
                                     List<String> discountIds)
                              throws RemoteException,
                                     ClientException,
                                     ServiceException,
                                     BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addTip

public Order addTip(String orderId,
                    String paymentId,
                    long amount,
                    boolean online)
             throws RemoteException,
                    ClientException,
                    ServiceException,
                    BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

pay

public Payment pay(String orderId,
                   PaymentRequest paymentRequest,
                   boolean isAllowOffline,
                   String note)
            throws RemoteException,
                   ClientException,
                   ServiceException,
                   BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

addPayment

@Deprecated
public Order addPayment(String orderId,
                        Payment payment,
                        List<LineItem> lineItems)
                 throws RemoteException,
                        ClientException,
                        ServiceException,
                        BindingException

Deprecated.

Use addPayment2(java.lang.String, com.clover.sdk.v3.payments.Payment, java.util.List<com.clover.sdk.v3.order.LineItem>).

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

addPayment2

public Order addPayment2(String orderId,
                         Payment payment,
                         List<LineItem> lineItems)
                  throws RemoteException,
                         ClientException,
                         ServiceException,
                         BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

removePayment

public Order removePayment(String orderId,
                           String paymentId)
                    throws RemoteException,
                           ClientException,
                           ServiceException,
                           BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidPayment

@Deprecated
public Order voidPayment(String orderId,
                         String paymentId)
                  throws RemoteException,
                         ClientException,
                         ServiceException,
                         BindingException

Deprecated.

Use voidPayment2(java.lang.String, java.lang.String, java.lang.String, com.clover.sdk.v3.order.VoidReason, java.lang.String).

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidPayment2

public Order voidPayment2(String orderId,
                          String paymentId,
                          String iccContainer,
                          VoidReason reason,
                          String source)
                   throws RemoteException,
                          ClientException,
                          ServiceException,
                          BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidPayment3

public Order voidPayment3(String orderId,
                          String paymentId,
                          String iccContainer,
                          Map<String,String> passThroughExtras,
                          VoidReason reason,
                          String source)
                   throws RemoteException,
                          ClientException,
                          ServiceException,
                          BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidPaymentWithCard

public Order voidPaymentWithCard(String orderId,
                                 String paymentId,
                                 String iccContainer,
                                 PaymentRequestCardDetails card,
                                 VoidReason reason,
                                 String source)
                          throws RemoteException,
                                 ClientException,
                                 ServiceException,
                                 BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidPaymentCardPresent

public Order voidPaymentCardPresent(String orderId,
                                    String paymentId,
                                    String iccContainer,
                                    PaymentRequestCardDetails card,
                                    TransactionInfo transactionInfo,
                                    VoidReason reason,
                                    String source)
                             throws RemoteException,
                                    ClientException,
                                    ServiceException,
                                    BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidPaymentCardPresent2

public Order voidPaymentCardPresent2(String orderId,
                                     String paymentId,
                                     String iccContainer,
                                     PaymentRequestCardDetails card,
                                     TransactionInfo transactionInfo,
                                     Map<String,String> passThroughExtras,
                                     VoidReason reason,
                                     String source)
                              throws RemoteException,
                                     ClientException,
                                     ServiceException,
                                     BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidPaymentCardPresent3

public Order voidPaymentCardPresent3(String orderId,
                                     String paymentId,
                                     String iccContainer,
                                     PaymentRequestCardDetails card,
                                     TransactionInfo transactionInfo,
                                     Map<String,String> passThroughExtras,
                                     VoidReason reason,
                                     VoidExtraData voidExtraData,
                                     String source)
                              throws RemoteException,
                                     ClientException,
                                     ServiceException,
                                     BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

addCredit

public Credit addCredit(String orderId,
                        Credit credit)
                 throws RemoteException,
                        ClientException,
                        ServiceException,
                        BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteCredit

public Order deleteCredit(String orderId,
                          String creditId)
                   throws RemoteException,
                          ClientException,
                          ServiceException,
                          BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addRefund

public Refund addRefund(String orderId,
                        Refund refund)
                 throws RemoteException,
                        ClientException,
                        ServiceException,
                        BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidRefundOffline

public Refund voidRefundOffline(String orderId,
                                Refund refund)
                         throws RemoteException,
                                ClientException,
                                ServiceException,
                                BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidRefund

public Refund voidRefund(String orderId,
                         Refund refund)
                  throws RemoteException,
                         ClientException,
                         ServiceException,
                         BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteRefund

public Order deleteRefund(String orderId,
                          String refundId)
                   throws RemoteException,
                          ClientException,
                          ServiceException,
                          BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addCreditRefund

public CreditRefund addCreditRefund(String orderId,
                                    CreditRefund creditRefund)
                             throws RemoteException,
                                    ClientException,
                                    ServiceException,
                                    BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteCreditRefund

public Order deleteCreditRefund(String orderId,
                                String creditRefundId)
                         throws RemoteException,
                                ClientException,
                                ServiceException,
                                BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

fire

public boolean fire(String orderId)
             throws RemoteException,
                    ClientException,
                    ServiceException,
                    BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

fire2

public boolean fire2(String orderId,
                     boolean requireAllItems)
              throws RemoteException,
                     ClientException,
                     ServiceException,
                     BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

firePrintGroups

public boolean firePrintGroups(String orderId,
                               @Nullable
                               List<String> printGroupIds,
                               boolean requireAllItems)
                        throws RemoteException,
                               ServiceException,
                               BindingException,
                               ClientException

Throws:

RemoteException

ServiceException

BindingException

ClientException

fireLineItems

public boolean fireLineItems(String orderId,
                             List<LineItem> lineItemList)
                      throws RemoteException,
                             ClientException,
                             ServiceException,
                             BindingException

Send all line items added in the List to the kitchen or order printer. Only prints items that have tags (also called labels) associating them with a printer

Parameters:

orderId - the ID of the order to fire.

lineItemList - list of line item items to be printed.

Returns:

true if items are printed, returns false line items or printers are empty.

Throws:

RemoteException

ClientException

ServiceException

BindingException

updatePayment

public Payment updatePayment(String orderId,
                             Payment payment)
                      throws RemoteException,
                             ClientException,
                             ServiceException,
                             BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

addOnOrderChangedListener

public void addOnOrderChangedListener(OrderV31Connector.OnOrderUpdateListener listener)

removeOnOrderChangedListener

public void removeOnOrderChangedListener(OrderV31Connector.OnOrderUpdateListener listener)

addRefundOffline

public Refund addRefundOffline(String orderId,
                               Refund refund)
                        throws RemoteException,
                               ClientException,
                               ServiceException,
                               BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

refund

public Refund refund(String orderId,
                     Refund refund)
              throws RemoteException,
                     ClientException,
                     ServiceException,
                     BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

refund2

public Refund refund2(String orderId,
                      Refund refund,
                      Map<String,String> passThroughExtras)
               throws RemoteException,
                      ClientException,
                      ServiceException,
                      BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

partialRefundV3

public Refund partialRefundV3(String orderId,
                              Refund refund,
                              boolean tipIncluded)
                       throws RemoteException,
                              ClientException,
                              ServiceException,
                              BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addPreAuth

public Order addPreAuth(String orderId,
                        Payment preAuth)
                 throws RemoteException,
                        ClientException,
                        ServiceException,
                        BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

capturePreAuth

@Deprecated
public Order capturePreAuth(String orderId,
                            Payment preAuth,
                            List<LineItem> lineItems)
                     throws RemoteException,
                            ClientException,
                            ServiceException,
                            BindingException

Deprecated.

This method has been deprecated because the payment used for the preauth is no longer the same as the payment for capture. Please use capturePreAuthorization(String, Payment, Payment, List)

Parameters:

orderId -

preAuth -

lineItems -

Returns:

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidPreAuth

public Order voidPreAuth(String orderId,
                         String preAuthId,
                         String iccContainer,
                         VoidReason voidReason,
                         String source)
                  throws RemoteException,
                         ClientException,
                         ServiceException,
                         BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deletePreAuth

public Order deletePreAuth(String orderId,
                           String paymentId,
                           VoidReason voidReason,
                           VoidExtraData voidExtraData)
                    throws RemoteException,
                           ClientException,
                           ServiceException,
                           BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

voidPreAuthOnline

public Order voidPreAuthOnline(String orderId,
                               String preAuthId,
                               String iccContainer,
                               VoidReason voidReason,
                               String source)
                        throws RemoteException,
                               ClientException,
                               ServiceException,
                               BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

cleanUpPreAuthAfterTransaction

public Order cleanUpPreAuthAfterTransaction(String orderId,
                                            VoidReason voidReason)
                                     throws RemoteException,
                                            ClientException,
                                            ServiceException,
                                            BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addOnOrderChangedListener

public void addOnOrderChangedListener(OrderV31Connector.OnOrderUpdateListener2 listener)

removeOnOrderChangedListener

public void removeOnOrderChangedListener(OrderV31Connector.OnOrderUpdateListener2 listener)

createLineItemsFrom2

public Map<String,List<LineItem>> createLineItemsFrom2(String sourceOrderId,
                                                             String destinationOrderId,
                                                             List<String> srclineItemIds,
                                                             boolean copyPrinted,
                                                             boolean broadcastLineItems)
                                                      throws RemoteException,
                                                             ClientException,
                                                             ServiceException,
                                                             BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteOrder2

public boolean deleteOrder2(String orderId,
                            boolean allowDeleteIfLineItemPrinted)
                     throws RemoteException,
                            ClientException,
                            ServiceException,
                            BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

getLineItemsToFire

public List<String> getLineItemsToFire(String orderId)
                                throws RemoteException,
                                       ServiceException,
                                       BindingException,
                                       ClientException

Throws:

RemoteException

ServiceException

BindingException

ClientException

refire

public boolean refire(String orderId)
               throws RemoteException,
                      ServiceException,
                      BindingException,
                      ClientException

Throws:

RemoteException

ServiceException

BindingException

ClientException

deleteOrderOnline2

@Deprecated
public boolean deleteOrderOnline2(String orderId,
                                  boolean usePermissionForOrderDeletions)
                           throws RemoteException,
                                  ClientException,
                                  ServiceException,
                                  BindingException

Deprecated.

Use deleteOrder3(java.lang.String, boolean, boolean, boolean).

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteOrder3

public boolean deleteOrder3(String orderId,
                            boolean deleteOnline,
                            boolean allowDeleteIfLineItemPrinted,
                            boolean allowDeleteIfNoEmployeePermission)
                     throws RemoteException,
                            ClientException,
                            ServiceException,
                            BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

vaultedCreditRefund

public CreditRefund vaultedCreditRefund(String orderId,
                                        String creditId)
                                 throws RemoteException,
                                        ClientException,
                                        ServiceException,
                                        BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

updateOnlineOrderState

public void updateOnlineOrderState(String orderId,
                                   OrderState orderState,
                                   Reason reason)
                            throws RemoteException,
                                   ClientException,
                                   ServiceException,
                                   BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

addTipWithAdditionalCharges

public Order addTipWithAdditionalCharges(String orderId,
                                         String paymentId,
                                         long amount,
                                         List<AdditionalChargeAmount> additionalChargeAmounts,
                                         boolean online)
                                  throws RemoteException,
                                         ClientException,
                                         ServiceException,
                                         BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

addServiceCharge2

public Order addServiceCharge2(String orderId,
                               String serviceChargeId,
                               boolean isAutoApplied)
                        throws RemoteException,
                               ClientException,
                               ServiceException,
                               BindingException

Adds service charge to the order

Parameters:

orderId - ID of the order to which service charge is added

isAutoApplied - a flag to indicate if service charge is auto applied

serviceChargeId - the ID of service charge which is to be added to order

Throws:

RemoteException

ClientException

ServiceException

BindingException

addLPMPayment

public Order addLPMPayment(String orderId,
                           Payment payment)
                    throws RemoteException,
                           ClientException,
                           ServiceException,
                           BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

updatePaymentStatus

public Payment updatePaymentStatus(String orderId,
                                   Payment payment)
                            throws RemoteException,
                                   ClientException,
                                   ServiceException,
                                   BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

addAuthorization

public Authorization addAuthorization(String orderId,
                                      Authorization authorization)
                               throws RemoteException,
                                      ClientException,
                                      ServiceException,
                                      BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

captureAuthorization

public Order captureAuthorization(String orderId,
                                  Authorization authorization)
                           throws RemoteException,
                                  ClientException,
                                  ServiceException,
                                  BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

queueVoid

public Order queueVoid(String orderId,
                       String paymentId,
                       String iccContainer,
                       PaymentRequestCardDetails card,
                       TransactionInfo transactionInfo,
                       Map<String,String> passThroughExtras,
                       VoidReason reason,
                       VoidExtraData voidExtraData,
                       String source)
                throws RemoteException,
                       ClientException,
                       ServiceException,
                       BindingException

Not available to non-Clover apps.

Throws:

RemoteException

ClientException

ServiceException

BindingException

addOrderFee

public Order addOrderFee(String orderId,
                         String orderFeeId)
                  throws RemoteException,
                         ClientException,
                         ServiceException,
                         BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

deleteOrderFee

public Order deleteOrderFee(String orderId,
                            String orderFeeLineItemId)
                     throws RemoteException,
                            ClientException,
                            ServiceException,
                            BindingException

Throws:

RemoteException

ClientException

ServiceException

BindingException

capturePreAuthorization

public Order capturePreAuthorization(String orderId,
                                     Payment preAuth,
                                     Payment closingPayment,
                                     List<LineItem> lineItems)
                              throws RemoteException,
                                     ClientException,
                                     ServiceException,
                                     BindingException

This method is used to capture a preauthorized payment.

Parameters:

orderId - -- ID of the order that the preauth and captured payment are associated with.

preAuth - -- The original preauth payment

closingPayment - -- The successfully captured payment.

lineItems - -- the line items associated with the payment.

Returns:

updated Order object

Throws:

RemoteException

ClientException

ServiceException

BindingException