Package com.clover.sdk.v3.order
Class IOrderServiceV3_1.Default
- java.lang.Object
-
- com.clover.sdk.v3.order.IOrderServiceV3_1.Default
-
- All Implemented Interfaces:
IInterface
,IOrderServiceV3_1
- Enclosing interface:
- IOrderServiceV3_1
public static class IOrderServiceV3_1.Default extends Object implements IOrderServiceV3_1
Default implementation for IOrderServiceV3_1.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.clover.sdk.v3.order.IOrderServiceV3_1
IOrderServiceV3_1.Default, IOrderServiceV3_1.Stub
-
-
Constructor Summary
Constructors Constructor Description Default()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AuthorizationFdParcelable
addAuthorization(String orderId, AuthorizationFdParcelable authorization, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
addBatchLineItemDiscounts(String orderId, List<String> lineItemIds, DiscountListFdParcelable discounts, ResultStatus status)
OrderFdParcelable
addBatchLineItemModifications(String orderId, List<String> lineItemIds, ModifierFdParcelable fdModifier, int quantity, ResultStatus status)
CreditFdParcelable
addCredit(String orderId, CreditFdParcelable fdCredit, ResultStatus status)
Not available to non-Clover apps.CreditRefundFdParcelable
addCreditRefund(String orderId, CreditRefundFdParcelable creditRefund, ResultStatus status)
Not available to non-Clover apps.LineItemFdParcelable
addCustomLineItem(String orderId, LineItemFdParcelable fdLineItem, boolean isTaxable, ResultStatus status)
Add a custom line item to an order.OrderFdParcelable
addDiscount(String orderId, DiscountFdParcelable fdDiscount, ResultStatus status)
DiscountFdParcelable
addDiscount2(String orderId, DiscountFdParcelable fdDiscount, ResultStatus status)
Just likeaddDiscount(java.lang.String, com.clover.sdk.v3.order.DiscountFdParcelable, com.clover.sdk.v1.ResultStatus)
but returns aDiscount
instead of anOrder
.LineItemFdParcelable
addFixedPriceLineItem(String orderId, String itemId, String binName, String userData, ResultStatus status)
Add a fixed-price line item to an order.LineItemListFdParcelable
addFixedPriceLineItems(String orderId, String itemId, String binName, String userData, int numItems, ResultStatus status)
Add 1 or more fixed-price line item to an order.OrderFdParcelable
addLineItemDiscount(String orderId, String lineItemId, DiscountFdParcelable fdDiscount, ResultStatus status)
DiscountFdParcelable
addLineItemDiscount2(String orderId, String lineItemId, DiscountFdParcelable fdDiscount, ResultStatus status)
Just likeaddLineItemDiscount(java.lang.String, java.lang.String, com.clover.sdk.v3.order.DiscountFdParcelable, com.clover.sdk.v1.ResultStatus)
but returns aDiscount
instead of anOrder
.OrderFdParcelable
addLineItemModification(String orderId, String lineItemId, ModifierFdParcelable fdModifier, ResultStatus status)
OrderFdParcelable
addLPMPayment(String orderId, PaymentFdParcelable payment, ResultStatus status)
Not available to non-Clover apps.void
addOnOrderUpdatedListener(IOnOrderUpdateListener listener)
void
addOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
OrderFdParcelable
addPayment(String orderId, PaymentFdParcelable fdPayment, LineItemListFdParcelable fdLineItems, ResultStatus status)
OrderFdParcelable
addPayment2(String orderId, PaymentFdParcelable fdPayment, LineItemListFdParcelable fdLineItems, ResultStatus status)
Not available to non-Clover apps.LineItemFdParcelable
addPerUnitLineItem(String orderId, String itemId, int unitQuantity, String binName, String userData, ResultStatus status)
Add a per-unit line item to an order.LineItemListFdParcelable
addPerUnitLineItems(String orderId, String itemId, int unitQuantity, String binName, String userData, int numItems, ResultStatus status)
Add 1 or more per-unit line item to an order.OrderFdParcelable
addPreAuth(String orderId, PaymentFdParcelable preAuth, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
addPrintGroup(String orderId, PrintGroupFdParcelable fdPrintGroup, ResultStatus status)
Add newPrintGroup
on order object.RefundFdParcelable
addRefund(String orderId, RefundFdParcelable refund, ResultStatus status)
Not available to non-Clover apps.RefundFdParcelable
addRefundOffline(String orderId, RefundFdParcelable fdRefund, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
addServiceCharge(String orderId, String serviceChargeId, ResultStatus status)
Add aServiceCharge
to an order.OrderFdParcelable
addServiceCharge2(String orderId, String serviceChargeId, boolean isAutoApplied, ResultStatus status)
Add aServiceCharge
to an order with a flag if it was added automatically or not.OrderFdParcelable
addTip(String orderId, String paymentId, long amount, boolean online, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
addTipWithAdditionalCharges(String orderId, String paymentId, long amount, List<AdditionalChargeAmount> addtionalChargeAmounts, boolean online, ResultStatus status)
Not available to non-Clover apps.LineItemFdParcelable
addVariablePriceLineItem(String orderId, String itemId, long price, String binName, String userData, ResultStatus status)
Add a variably-priced line item to the order.LineItemListFdParcelable
addVariablePriceLineItems(String orderId, String itemId, long price, String binName, String userData, int numItems, ResultStatus status)
Add 1 or more variably-priced line item to the order.IBinder
asBinder()
OrderFdParcelable
captureAuthorization(String orderId, AuthorizationFdParcelable authorization, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
capturePreAuth(String orderId, PaymentFdParcelable preAuth, LineItemListFdParcelable fdLineItems, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
cleanUpPreAuthAfterTransaction(String orderId, VoidReason voidReason, ResultStatus status)
Not available to non-Clover apps.LineItemListFdParcelable
copyLineItems(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status)
LineItemMapFdParcelable
createLineItemsFrom(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status)
LineItemMapFdParcelable
createLineItemsFrom2(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, boolean copyPrinted, boolean broadcastLineItems, ResultStatus status)
Just likecreateLineItemsFrom(java.lang.String, java.lang.String, java.util.List<java.lang.String>, com.clover.sdk.v1.ResultStatus)
but additionally when copyPrinted is set to true it will copy print flags on line items (normally did not), and when broadcastLineItems is set to true it will broadcastLineItems (normally did).OrderFdParcelable
createOrder(OrderFdParcelable fdOrder, ResultStatus status)
Create a newOrder
.OrderFdParcelable
deleteCredit(String orderId, String creditId, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
deleteCreditRefund(String orderId, String creditRefundId, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
deleteDiscounts(String orderId, List<String> discountIds, ResultStatus status)
OrderFdParcelable
deleteLineItemDiscounts(String orderId, String lineItemId, List<String> discountIds, ResultStatus status)
OrderFdParcelable
deleteLineItemModifications(String orderId, String lineItemId, List<String> modificationIds, ResultStatus status)
OrderFdParcelable
deleteLineItems(String orderId, List<String> lineItemIds, ResultStatus status)
OrderFdParcelable
deleteLineItems2(String orderId, List<String> lineItemIds, ClientEventType clientEventType, String approvedByEmployeeId, ResultStatus status)
OrderFdParcelable
deleteLineItemsWithReason(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType, ResultStatus status)
OrderFdParcelable
deleteLineItemsWithReason2(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType, String approvedByEmployeeId, ResultStatus status)
boolean
deleteOrder(String orderId, ResultStatus status)
Delete anOrder
.boolean
deleteOrder2(String orderId, boolean allowDeleteIfLineItemPrinted, ResultStatus status)
Just likedeleteOrder(java.lang.String, com.clover.sdk.v1.ResultStatus)
but additionally when allowDeleteIfLineItemPrinted is true it will delete the order when line items are printed (normally did not).boolean
deleteOrder3(String orderId, boolean deleteOnline, boolean allowDeleteIfLineItemPrinted, boolean allowDeleteIfNoEmployeePermission, ResultStatus status)
Delete anOrder
.boolean
deleteOrderOnline(String orderId, ResultStatus status)
Delete anOrder
synchronously on the server.boolean
deleteOrderOnline2(String orderId, boolean usePermissionForOrderDeletions, ResultStatus status)
OrderFdParcelable
deletePreAuth(String orderId, String paymentId, VoidReason voidReason, VoidExtraData voidExtraData, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
deleteRefund(String orderId, String refundId, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
deleteServiceCharge(String orderId, String serviceChargeId, ResultStatus status)
Add aServiceCharge
to an order.LineItemFdParcelable
exchangeItem(String orderId, String oldLineItemId, String itemId, String binName, String userData, ResultStatus status)
boolean
fire(String sourceOrderId, ResultStatus status)
Print line items to the kitchen or order printer quickly.boolean
fire2(String sourceOrderid, boolean requireAllItems, ResultStatus status)
Just likefire(java.lang.String, com.clover.sdk.v1.ResultStatus)
but additionally when requireAllItems is set to true it will not print and return false if some items on the order haven't been printed yet and would not be printed because they are not associated with an order printer.boolean
firePrintGroups(String orderId, List<String> printGroupsIds, boolean requireAllItems, ResultStatus status)
Send all line items in the given print groups to the kitchen or order printer.List<String>
getLineItemsToFire(String orderId, ResultStatus status)
Get list of lineitem ids for the order that has printtag to print.OrderFdParcelable
getOrder(String orderId, ResultStatus status)
Get theOrder
for the given ID.OrderListFdParcelable
getOrders(List<String> orderIds, ResultStatus status)
Get theOrder
s for the given IDs.PaymentListFdParcelable
getPendingPayments(ResultStatus status)
This pulls pending payments from the local device dbRefundFdParcelable
partialRefundV3(String orderId, RefundFdParcelable fdRefund, boolean tipIncluded, ResultStatus resultStatus)
Not available to non-Clover apps.PaymentFdParcelable
pay(String orderId, PaymentRequestFdParcelable fdPaymentRequest, boolean isAllowOffline, String note, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
queueVoid(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map passThroughExtras, VoidReason reason, VoidExtraData voidExtraData, String source, ResultStatus resultStatus)
Not available to non-Clover apps.boolean
refire(String orderId, ResultStatus status)
Reprint all lineitems that has a printtag even if they are printed.RefundFdParcelable
refund(String orderId, RefundFdParcelable fdRefund, ResultStatus status)
Not available to non-Clover apps.RefundFdParcelable
refund2(String orderId, RefundFdParcelable fdRefund, Map passThroughExtras, ResultStatus resultStatus)
Refund with passthrough data Not available to non-Clover apps.void
removeOnOrderUpdatedListener(IOnOrderUpdateListener listener)
void
removeOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
OrderFdParcelable
removePayment(String orderId, String paymentId, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
setLineItemNote(String orderId, String lineItemId, String note, ResultStatus status)
LineItemListFdParcelable
splitLineItems(String orderId, List<String> lineItemIds, List<String> binNames, ResultStatus resultStatus)
Splits line items without taking a payment.LineItemListFdParcelable
updateLineItems(String orderId, LineItemListFdParcelable fdLineItems, ResultStatus status)
void
updateOnlineOrderState(String orderId, OrderState orderState, Reason reason, ResultStatus resultStatus)
Update the online order state.OrderFdParcelable
updateOrder(OrderFdParcelable fdOrder, ResultStatus status)
Update anOrder
.PaymentFdParcelable
updatePayment(String orderId, PaymentFdParcelable fdPayment, ResultStatus status)
Not available to non-Clover apps.PaymentFdParcelable
updatePaymentStatus(String orderId, PaymentFdParcelable payment, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
updatePrintGroup(String orderId, PrintGroupFdParcelable fdPrintGroupToUpdate, ResultStatus status)
UpdatePrintGroup
on order object.CreditRefund
vaultedCreditRefund(String orderId, String creditId, ResultStatus status)
OrderFdParcelable
voidPayment(String orderId, String paymentId, ResultStatus status)
OrderFdParcelable
voidPayment2(String orderId, String paymentId, String iccContainer, VoidReason reason, String source, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
voidPayment3(String orderId, String paymentId, String iccContainer, Map passThroughExtras, VoidReason reason, String source, ResultStatus status)
Card not present void with passthrough data Not available to non-Clover apps.OrderFdParcelable
voidPaymentCardPresent(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, VoidReason reason, String source, ResultStatus status)
Card present void Not available to non-Clover apps.OrderFdParcelable
voidPaymentCardPresent2(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map passThroughExtras, VoidReason reason, String source, ResultStatus resultStatus)
Card present void with passthrough data Not available to non-Clover apps.OrderFdParcelable
voidPaymentCardPresent3(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map passThroughExtras, VoidReason reason, VoidExtraData voidExtraData, String source, ResultStatus resultStatus)
Card present void with passthrough data and POI components.OrderFdParcelable
voidPaymentWithCard(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, VoidReason reason, String source, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
voidPreAuth(String orderId, String preAuthId, String iccContainer, VoidReason voidReason, String source, ResultStatus status)
Not available to non-Clover apps.OrderFdParcelable
voidPreAuthOnline(String orderId, String preAuthId, String iccContainer, VoidReason voidReason, String source, ResultStatus status)
Not available to non-Clover apps.RefundFdParcelable
voidRefund(String orderId, RefundFdParcelable fdRefund, ResultStatus status)
Not available to non-Clover apps.RefundFdParcelable
voidRefundOffline(String orderId, RefundFdParcelable fdRefund, ResultStatus status)
Not available to non-Clover apps.
-
-
-
Method Detail
-
addOnOrderUpdatedListener
public void addOnOrderUpdatedListener(IOnOrderUpdateListener listener) throws RemoteException
- Specified by:
addOnOrderUpdatedListener
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
removeOnOrderUpdatedListener
public void removeOnOrderUpdatedListener(IOnOrderUpdateListener listener) throws RemoteException
- Specified by:
removeOnOrderUpdatedListener
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
getOrder
public OrderFdParcelable getOrder(String orderId, ResultStatus status) throws RemoteException
Get theOrder
for the given ID. If the order is not synchronized on this device, the order is fetched from the server.- Specified by:
getOrder
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of theOrder
to retrieve.- Returns:
- The
Order
s corresponding to the provided ID, or {@link null} if the order does not exists locally and it cannot be fetched from the server. Note that this may be because the server is not reachable or because the order for the given ID does not exist. - Throws:
RemoteException
-
getOrders
public OrderListFdParcelable getOrders(List<String> orderIds, ResultStatus status) throws RemoteException
Get theOrder
s for the given IDs. If the orders are not synchronized on this device, they are fetched from the server.- Specified by:
getOrders
in interfaceIOrderServiceV3_1
- Parameters:
orderIds
- The list of orders to retrieve- Returns:
- The list of
Order
s corresponding to the provided IDs - Throws:
RemoteException
-
createOrder
public OrderFdParcelable createOrder(OrderFdParcelable fdOrder, ResultStatus status) throws RemoteException
Create a newOrder
. Only the following fields are allowed during creation:- title
- List
- orderType.id
- note
The following fields are set automatically by this call:
- id
- device - set the this device.
- currency - set to the merchant's currency.
- vat - set according to the merchant's setting.
- groupLineItems - set according to the merchant's setting.
- testMode - set according to the merchant's setting.
- createdTime - set to this device's current time.
- taxRemoved - set to false.
- total - set to 0.
- employee - set to the current employee logged into this device.
Any other fields included in this call will result in failure to create the order. Adding line items and making other changes should be done after order creation using other methods in this class.
- Specified by:
createOrder
in interfaceIOrderServiceV3_1
- Parameters:
order
- The order to create.- Throws:
RemoteException
-
updateOrder
public OrderFdParcelable updateOrder(OrderFdParcelable fdOrder, ResultStatus status) throws RemoteException
Update anOrder
. The following fields may be updated,- title
- note
- taxRemoved
- groupLineItems
- manualTransactions
- testMode
- orderType.id
- List
- payType
- employee.id
- Specified by:
updateOrder
in interfaceIOrderServiceV3_1
- Parameters:
order
- TheOrder
to updated.- Throws:
RemoteException
-
deleteOrder
public boolean deleteOrder(String orderId, ResultStatus status) throws RemoteException
Delete anOrder
.- Specified by:
deleteOrder
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of theOrder
to be deleted.- Returns:
- true if the
Order
was deleted successfully, otherwise false. - Throws:
RemoteException
- See Also:
deleteOrderOnline(java.lang.String, com.clover.sdk.v1.ResultStatus)
-
addServiceCharge
public OrderFdParcelable addServiceCharge(String orderId, String serviceChargeId, ResultStatus status) throws RemoteException
Add aServiceCharge
to an order.- Specified by:
addServiceCharge
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The order ID on which to add the service charge.serviceChargeId
- The ID of the service charge to be added to the order.- Returns:
- The updated order with the service charge added.
- Throws:
RemoteException
-
deleteServiceCharge
public OrderFdParcelable deleteServiceCharge(String orderId, String serviceChargeId, ResultStatus status) throws RemoteException
Add aServiceCharge
to an order.- Specified by:
deleteServiceCharge
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The order ID on which to add the service charge.serviceChargeId
- The ID of the service charge to be added to the order.- Returns:
- The updated order with the service charge removed.
- Throws:
RemoteException
-
addFixedPriceLineItem
public LineItemFdParcelable addFixedPriceLineItem(String orderId, String itemId, String binName, String userData, ResultStatus status) throws RemoteException
Add a fixed-price line item to an order. A fixed price line item is priced per item.LineItem
s are linked toItem
s with an item ID. Think of theItem
as a template for creating aLineItem
, and aLineItem
as the order's copy of anItem
.- Specified by:
addFixedPriceLineItem
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to which to add the line item.itemId
- The item ID from which to create the line item to be added to the order.binName
- The BIN name for the line item. May be {@link null}.userData
- Meta-data to attach to the line item. May be {@link null}.- Returns:
- The newly created
LineItem
. - Throws:
RemoteException
-
addPerUnitLineItem
public LineItemFdParcelable addPerUnitLineItem(String orderId, String itemId, int unitQuantity, String binName, String userData, ResultStatus status) throws RemoteException
Add a per-unit line item to an order. A per unit line item is priced per unit, not per item. A good example is items that are sold by weight (e.g., per ounce).LineItem
s are linked toItem
s with an item ID. Think of theItem
as a template for creating aLineItem
, and aLineItem
as the order's copy of anItem
.- Specified by:
addPerUnitLineItem
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to which to add the line item.itemId
- The item ID from which to create the line item to be added to the order.unitQuantity
- The unit quantity for the line item (e.g., "10 ounces").binName
- The BIN name for the line item. May be {@link null}.userData
- Meta-data to attach to the line item. May be {@link null}.- Returns:
- The newly created
LineItem
. - Throws:
RemoteException
-
addVariablePriceLineItem
public LineItemFdParcelable addVariablePriceLineItem(String orderId, String itemId, long price, String binName, String userData, ResultStatus status) throws RemoteException
Add a variably-priced line item to the order. A variably priced line item's price is determined at the time of sale. Note that this method is not consistent with others in this interface as it returns aLineItem
. All other methods return the complete, updatedOrder
.- Specified by:
addVariablePriceLineItem
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to which to add the line item.itemId
- The item ID from which to create the line item to be added to the order.price
- The price of the line item.binName
- The BIN name for the line item. May be {@link null}.userData
- Meta-data to attach to the line item. May be {@link null}.- Throws:
RemoteException
-
addCustomLineItem
public LineItemFdParcelable addCustomLineItem(String orderId, LineItemFdParcelable fdLineItem, boolean isTaxable, ResultStatus status) throws RemoteException
Add a custom line item to an order. Custom line items are not associated with an inventory item. Note that this method is not consistent with others in this interface as it returns aLineItem
. All other methods return the complete, updatedOrder
.- Specified by:
addCustomLineItem
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to which to add the line item.lineItem
- The line item to add to the order.isTaxable
- true if this line item is taxable, otherwise false.- Throws:
RemoteException
-
updateLineItems
public LineItemListFdParcelable updateLineItems(String orderId, LineItemListFdParcelable fdLineItems, ResultStatus status) throws RemoteException
UpdateLineItem
s on anOrder
. Only the following fields may be updated,- binName
- printed
- note
- userData
- Specified by:
updateLineItems
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order on which to update the line items.lineItemIds
- TheLineItem
s to update on the order.- Returns:
- The updated
LineItem
s. - Throws:
RemoteException
-
deleteLineItems
public OrderFdParcelable deleteLineItems(String orderId, List<String> lineItemIds, ResultStatus status) throws RemoteException
- Specified by:
deleteLineItems
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of theOrder
from which to delete the line items.lineItemIds
- TheLineItem
IDs to delete.- Returns:
- The updated
Order
. - Throws:
RemoteException
-
copyLineItems
public LineItemListFdParcelable copyLineItems(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status) throws RemoteException
- Specified by:
copyLineItems
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
setLineItemNote
public OrderFdParcelable setLineItemNote(String orderId, String lineItemId, String note, ResultStatus status) throws RemoteException
- Specified by:
setLineItemNote
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addLineItemModification
public OrderFdParcelable addLineItemModification(String orderId, String lineItemId, ModifierFdParcelable fdModifier, ResultStatus status) throws RemoteException
- Specified by:
addLineItemModification
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteLineItemModifications
public OrderFdParcelable deleteLineItemModifications(String orderId, String lineItemId, List<String> modificationIds, ResultStatus status) throws RemoteException
- Specified by:
deleteLineItemModifications
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
exchangeItem
public LineItemFdParcelable exchangeItem(String orderId, String oldLineItemId, String itemId, String binName, String userData, ResultStatus status) throws RemoteException
- Specified by:
exchangeItem
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addDiscount
public OrderFdParcelable addDiscount(String orderId, DiscountFdParcelable fdDiscount, ResultStatus status) throws RemoteException
- Specified by:
addDiscount
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteDiscounts
public OrderFdParcelable deleteDiscounts(String orderId, List<String> discountIds, ResultStatus status) throws RemoteException
- Specified by:
deleteDiscounts
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addLineItemDiscount
public OrderFdParcelable addLineItemDiscount(String orderId, String lineItemId, DiscountFdParcelable fdDiscount, ResultStatus status) throws RemoteException
- Specified by:
addLineItemDiscount
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteLineItemDiscounts
public OrderFdParcelable deleteLineItemDiscounts(String orderId, String lineItemId, List<String> discountIds, ResultStatus status) throws RemoteException
- Specified by:
deleteLineItemDiscounts
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addTip
public OrderFdParcelable addTip(String orderId, String paymentId, long amount, boolean online, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addTip
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
pay
public PaymentFdParcelable pay(String orderId, PaymentRequestFdParcelable fdPaymentRequest, boolean isAllowOffline, String note, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
pay
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addPayment
public OrderFdParcelable addPayment(String orderId, PaymentFdParcelable fdPayment, LineItemListFdParcelable fdLineItems, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addPayment
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
voidPayment
public OrderFdParcelable voidPayment(String orderId, String paymentId, ResultStatus status) throws RemoteException
Deprecated.Not available to non-Clover apps.- Specified by:
voidPayment
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addCredit
public CreditFdParcelable addCredit(String orderId, CreditFdParcelable fdCredit, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addCredit
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteCredit
public OrderFdParcelable deleteCredit(String orderId, String creditId, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
deleteCredit
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addRefund
public RefundFdParcelable addRefund(String orderId, RefundFdParcelable refund, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addRefund
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteRefund
public OrderFdParcelable deleteRefund(String orderId, String refundId, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
deleteRefund
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteOrderOnline
public boolean deleteOrderOnline(String orderId, ResultStatus status) throws RemoteException
Delete anOrder
synchronously on the server. Differing from#deleteOrder(String)
, this method only completes successfully if this device can reach the server and retrieve confirmation that the order was deleted.- Specified by:
deleteOrderOnline
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to be deleted.- Returns:
- true if the order was deleted successfully, otherwise false.
- Throws:
RemoteException
- See Also:
deleteOrder(java.lang.String, com.clover.sdk.v1.ResultStatus)
-
addBatchLineItemModifications
public OrderFdParcelable addBatchLineItemModifications(String orderId, List<String> lineItemIds, ModifierFdParcelable fdModifier, int quantity, ResultStatus status) throws RemoteException
- Specified by:
addBatchLineItemModifications
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addBatchLineItemDiscounts
public OrderFdParcelable addBatchLineItemDiscounts(String orderId, List<String> lineItemIds, DiscountListFdParcelable discounts, ResultStatus status) throws RemoteException
- Specified by:
addBatchLineItemDiscounts
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
createLineItemsFrom
public LineItemMapFdParcelable createLineItemsFrom(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status) throws RemoteException
- Specified by:
createLineItemsFrom
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
fire
public boolean fire(String sourceOrderId, ResultStatus status) throws RemoteException
Print line items to the kitchen or order printer quickly. Only prints inventory items that are associated with a printer. The association is done by linking an item and a printer with a tag. It will only print line items once, subsequent invocations will not cause additional prints, but the method will still return true.- Specified by:
fire
in interfaceIOrderServiceV3_1
- Returns:
- true, unless the order has no line items in it that can be fired to a printer, will return true but not print anything if all items have been already printed
- Throws:
RemoteException
- See Also:
com.clover.sdk.v3.inventory.IInventoryService.assignTagsToItem
-
updatePayment
public PaymentFdParcelable updatePayment(String orderId, PaymentFdParcelable fdPayment, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
updatePayment
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
voidPayment2
public OrderFdParcelable voidPayment2(String orderId, String paymentId, String iccContainer, VoidReason reason, String source, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
voidPayment2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
removePayment
public OrderFdParcelable removePayment(String orderId, String paymentId, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
removePayment
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addRefundOffline
public RefundFdParcelable addRefundOffline(String orderId, RefundFdParcelable fdRefund, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addRefundOffline
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
refund
public RefundFdParcelable refund(String orderId, RefundFdParcelable fdRefund, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
refund
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addOnOrderUpdatedListener2
public void addOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener) throws RemoteException
- Specified by:
addOnOrderUpdatedListener2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
removeOnOrderUpdatedListener2
public void removeOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener) throws RemoteException
- Specified by:
removeOnOrderUpdatedListener2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addDiscount2
public DiscountFdParcelable addDiscount2(String orderId, DiscountFdParcelable fdDiscount, ResultStatus status) throws RemoteException
Just likeaddDiscount(java.lang.String, com.clover.sdk.v3.order.DiscountFdParcelable, com.clover.sdk.v1.ResultStatus)
but returns aDiscount
instead of anOrder
.- Specified by:
addDiscount2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addLineItemDiscount2
public DiscountFdParcelable addLineItemDiscount2(String orderId, String lineItemId, DiscountFdParcelable fdDiscount, ResultStatus status) throws RemoteException
Just likeaddLineItemDiscount(java.lang.String, java.lang.String, com.clover.sdk.v3.order.DiscountFdParcelable, com.clover.sdk.v1.ResultStatus)
but returns aDiscount
instead of anOrder
.- Specified by:
addLineItemDiscount2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addPayment2
public OrderFdParcelable addPayment2(String orderId, PaymentFdParcelable fdPayment, LineItemListFdParcelable fdLineItems, ResultStatus status) throws RemoteException
Not available to non-Clover apps. Add a payment to an order. The payment is only added to the local DB: the change is not persisted on the server. This method differs fromaddPayment(java.lang.String, com.clover.sdk.v3.payments.PaymentFdParcelable, com.clover.sdk.v3.order.LineItemListFdParcelable, com.clover.sdk.v1.ResultStatus)
in that it does not add cash events or open the cash drawer. Not available to non-Clover apps.- Specified by:
addPayment2
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- , the order ID.payment
- , the payment.lineItems
- , the line items that were paid by this payment.- Returns:
- the updated order.
- Throws:
RemoteException
-
fire2
public boolean fire2(String sourceOrderid, boolean requireAllItems, ResultStatus status) throws RemoteException
Just likefire(java.lang.String, com.clover.sdk.v1.ResultStatus)
but additionally when requireAllItems is set to true it will not print and return false if some items on the order haven't been printed yet and would not be printed because they are not associated with an order printer.- Specified by:
fire2
in interfaceIOrderServiceV3_1
- Returns:
- just like
fire(java.lang.String, com.clover.sdk.v1.ResultStatus)
, but additionally returns false if there are unprinted items without a printer associated. - Throws:
RemoteException
-
createLineItemsFrom2
public LineItemMapFdParcelable createLineItemsFrom2(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, boolean copyPrinted, boolean broadcastLineItems, ResultStatus status) throws RemoteException
Just likecreateLineItemsFrom(java.lang.String, java.lang.String, java.util.List<java.lang.String>, com.clover.sdk.v1.ResultStatus)
but additionally when copyPrinted is set to true it will copy print flags on line items (normally did not), and when broadcastLineItems is set to true it will broadcastLineItems (normally did).- Specified by:
createLineItemsFrom2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteOrder2
public boolean deleteOrder2(String orderId, boolean allowDeleteIfLineItemPrinted, ResultStatus status) throws RemoteException
Just likedeleteOrder(java.lang.String, com.clover.sdk.v1.ResultStatus)
but additionally when allowDeleteIfLineItemPrinted is true it will delete the order when line items are printed (normally did not).- Specified by:
deleteOrder2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
getPendingPayments
public PaymentListFdParcelable getPendingPayments(ResultStatus status) throws RemoteException
This pulls pending payments from the local device db- Specified by:
getPendingPayments
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addCreditRefund
public CreditRefundFdParcelable addCreditRefund(String orderId, CreditRefundFdParcelable creditRefund, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addCreditRefund
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteCreditRefund
public OrderFdParcelable deleteCreditRefund(String orderId, String creditRefundId, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
deleteCreditRefund
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addPreAuth
public OrderFdParcelable addPreAuth(String orderId, PaymentFdParcelable preAuth, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addPreAuth
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
capturePreAuth
public OrderFdParcelable capturePreAuth(String orderId, PaymentFdParcelable preAuth, LineItemListFdParcelable fdLineItems, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
capturePreAuth
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
voidPreAuth
public OrderFdParcelable voidPreAuth(String orderId, String preAuthId, String iccContainer, VoidReason voidReason, String source, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
voidPreAuth
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
voidPreAuthOnline
public OrderFdParcelable voidPreAuthOnline(String orderId, String preAuthId, String iccContainer, VoidReason voidReason, String source, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
voidPreAuthOnline
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteLineItemsWithReason
public OrderFdParcelable deleteLineItemsWithReason(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType, ResultStatus status) throws RemoteException
- Specified by:
deleteLineItemsWithReason
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of theOrder
from which to delete the line items.lineItemIds
- TheLineItem
IDs to delete.reason
- optional. Why was the line item removed?clientEventType
- optional. What app did the delete come from?- Returns:
- The updated
Order
. - Throws:
RemoteException
-
voidPaymentWithCard
public OrderFdParcelable voidPaymentWithCard(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, VoidReason reason, String source, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
voidPaymentWithCard
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
getLineItemsToFire
public List<String> getLineItemsToFire(String orderId, ResultStatus status) throws RemoteException
Get list of lineitem ids for the order that has printtag to print. The items that are already printed are not part of the list- Specified by:
getLineItemsToFire
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of theOrder
from which to delete the line items.- Throws:
RemoteException
-
refire
public boolean refire(String orderId, ResultStatus status) throws RemoteException
Reprint all lineitems that has a printtag even if they are printed.- Specified by:
refire
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of theOrder
from which to delete the line items.- Throws:
RemoteException
-
addFixedPriceLineItems
public LineItemListFdParcelable addFixedPriceLineItems(String orderId, String itemId, String binName, String userData, int numItems, ResultStatus status) throws RemoteException
Add 1 or more fixed-price line item to an order. A fixed price line item is priced per item.LineItem
s are linked toItem
s with an item ID. Think of theItem
as a template for creating aLineItem
, and aLineItem
as the order's copy of anItem
.- Specified by:
addFixedPriceLineItems
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to which to add the line item.itemId
- The item ID from which to create the line item to be added to the order.binName
- The BIN name for the line item. May be {@link null}.userData
- Meta-data to attach to the line item. May be {@link null}.numItems
- number ofLineItem
s to create- Returns:
- The newly created
LineItem
. - Throws:
RemoteException
-
addPerUnitLineItems
public LineItemListFdParcelable addPerUnitLineItems(String orderId, String itemId, int unitQuantity, String binName, String userData, int numItems, ResultStatus status) throws RemoteException
Add 1 or more per-unit line item to an order. A per unit line item is priced per unit, not per item. A good example is items that are sold by weight (e.g., per ounce).LineItem
s are linked toItem
s with an item ID. Think of theItem
as a template for creating aLineItem
, and aLineItem
as the order's copy of anItem
.- Specified by:
addPerUnitLineItems
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to which to add the line item.itemId
- The item ID from which to create the line item to be added to the order.unitQuantity
- The unit quantity for the line item (e.g., "10 ounces").binName
- The BIN name for the line item. May be {@link null}.userData
- Meta-data to attach to the line item. May be {@link null}.numItems
- number ofLineItem
s to create- Returns:
- The newly created
LineItem
. - Throws:
RemoteException
-
addVariablePriceLineItems
public LineItemListFdParcelable addVariablePriceLineItems(String orderId, String itemId, long price, String binName, String userData, int numItems, ResultStatus status) throws RemoteException
Add 1 or more variably-priced line item to the order. A variably priced line item's price is determined at the time of sale. Note that this method is not consistent with others in this interface as it returns aLineItem
. All other methods return the complete, updatedOrder
.- Specified by:
addVariablePriceLineItems
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to which to add the line item.itemId
- The item ID from which to create the line item to be added to the order.price
- The price of the line item.binName
- The BIN name for the line item. May be {@link null}.userData
- Meta-data to attach to the line item. May be {@link null}.numItems
- number ofLineItem
s to create- Returns:
- The newly created
LineItem
. - Throws:
RemoteException
-
deleteOrderOnline2
public boolean deleteOrderOnline2(String orderId, boolean usePermissionForOrderDeletions, ResultStatus status) throws RemoteException
Deprecated.Not available to non-Clover apps.- Specified by:
deleteOrderOnline2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteOrder3
public boolean deleteOrder3(String orderId, boolean deleteOnline, boolean allowDeleteIfLineItemPrinted, boolean allowDeleteIfNoEmployeePermission, ResultStatus status) throws RemoteException
Delete anOrder
. This method allows switching between online deletion like#deleteOrderOnline(String)
and offline (deleting loaclly and adding message to server queue) like#deleteOrder(String)
This method allows an override toggle for the employee permissions and printed line items checks.- Specified by:
deleteOrder3
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to be deleted.deleteOnline
- true to delete an order synchronously on the server @see #deleteOrderOnlineallowDeleteIfLineItemPrinted
- true to allow deleting order if it has printed line itemsallowDeleteIfNoEmployeePermission
- true to allow deletion regardless of employee permission.- Returns:
- true if the order was deleted successfully, otherwise false. Not available to non-Clover apps.
- Throws:
RemoteException
-
voidPaymentCardPresent
public OrderFdParcelable voidPaymentCardPresent(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, VoidReason reason, String source, ResultStatus status) throws RemoteException
Card present void Not available to non-Clover apps.- Specified by:
voidPaymentCardPresent
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
voidPayment3
public OrderFdParcelable voidPayment3(String orderId, String paymentId, String iccContainer, Map passThroughExtras, VoidReason reason, String source, ResultStatus status) throws RemoteException
Card not present void with passthrough data Not available to non-Clover apps.- Specified by:
voidPayment3
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
voidPaymentCardPresent2
public OrderFdParcelable voidPaymentCardPresent2(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map passThroughExtras, VoidReason reason, String source, ResultStatus resultStatus) throws RemoteException
Card present void with passthrough data Not available to non-Clover apps.- Specified by:
voidPaymentCardPresent2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
refund2
public RefundFdParcelable refund2(String orderId, RefundFdParcelable fdRefund, Map passThroughExtras, ResultStatus resultStatus) throws RemoteException
Refund with passthrough data Not available to non-Clover apps.- Specified by:
refund2
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
cleanUpPreAuthAfterTransaction
public OrderFdParcelable cleanUpPreAuthAfterTransaction(String orderId, VoidReason voidReason, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
cleanUpPreAuthAfterTransaction
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
splitLineItems
public LineItemListFdParcelable splitLineItems(String orderId, List<String> lineItemIds, List<String> binNames, ResultStatus resultStatus) throws RemoteException
Splits line items without taking a payment. EachLineItem
inlineItemIds
is equally split across all bins inbinNames
. For example, given a single line item ID and bin names "a" and "b", then two new line items are created. One for bin "a" and another for bin "b". The original line item is then deleted. Each new line item represents an equal fraction of the original by using a fraction of the original's unit quantity. Using this method allows for items to be shared without locking the order.Restrictions A line item may not be split more than once. If a line item cannot be split, it is skipped.
- Specified by:
splitLineItems
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- the ID of the order to modify.lineItemIds
- the line items to split.binNames
- the bin names to splitlineItemIds
across.- Returns:
- the newly created
LineItem
s. - Throws:
RemoteException
-
vaultedCreditRefund
public CreditRefund vaultedCreditRefund(String orderId, String creditId, ResultStatus status) throws RemoteException
- Specified by:
vaultedCreditRefund
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to be updated.creditId
- The ID of the credit to be refunded.- Returns:
- the CreditRefund object constructed using the RefundResponse the serverf returns Not available to non-Clover apps.
- Throws:
RemoteException
-
updateOnlineOrderState
public void updateOnlineOrderState(String orderId, OrderState orderState, Reason reason, ResultStatus resultStatus) throws RemoteException
Update the online order state.- Specified by:
updateOnlineOrderState
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addPrintGroup
public OrderFdParcelable addPrintGroup(String orderId, PrintGroupFdParcelable fdPrintGroup, ResultStatus status) throws RemoteException
Add newPrintGroup
on order object.- Specified by:
addPrintGroup
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to be updatedfdPrintGroup
- PrintGroup to be added to an Order- Returns:
- the updated order
- Throws:
RemoteException
-
deleteLineItems2
public OrderFdParcelable deleteLineItems2(String orderId, List<String> lineItemIds, ClientEventType clientEventType, String approvedByEmployeeId, ResultStatus status) throws RemoteException
- Specified by:
deleteLineItems2
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of theOrder
from which to delete the line items.lineItemIds
- TheLineItem
IDs to delete.clientEventType
- What app did the delete come from? If null, no clientEventType will be added.approvedByEmployeeId
- Approval id of the employee who approved the deletion of the line item, if null no approver is added.- Returns:
- The updated
Order
. - Throws:
RemoteException
-
voidPaymentCardPresent3
public OrderFdParcelable voidPaymentCardPresent3(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map passThroughExtras, VoidReason reason, VoidExtraData voidExtraData, String source, ResultStatus resultStatus) throws RemoteException
Card present void with passthrough data and POI components. Not available to non-Clover apps.- Specified by:
voidPaymentCardPresent3
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addTipWithAdditionalCharges
public OrderFdParcelable addTipWithAdditionalCharges(String orderId, String paymentId, long amount, List<AdditionalChargeAmount> addtionalChargeAmounts, boolean online, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addTipWithAdditionalCharges
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
firePrintGroups
public boolean firePrintGroups(String orderId, List<String> printGroupsIds, boolean requireAllItems, ResultStatus status) throws RemoteException
Send all line items in the given print groups to the kitchen or order printer. Only prints items that have tags (also called labels) associating them with a printer. Line items will only be printed once. Subsequent invocations will not cause additional prints, but the method will still return true.- Specified by:
firePrintGroups
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- the ID of the order to fire.printGroupIds
- fire items from all given PrintGroups. If null, fire all PrintGroups.requireAllItems
- when true, it will not print and return false if some items in the PrintGroups haven't been printed and will not be printed because they are not associated with an order printer.- Returns:
- behaves like
fire(String, ResultStatus)
whenrequireAllItems
is false. WhenrequireAllItems
is true, returns false if there are unprinted items without a printer associated. - Throws:
RemoteException
- See Also:
com.clover.sdk.v3.inventory.IInventoryService.assignTagsToItem
,com.clover.sdk.v3.order.IOrderServiceV3_1.addPrintGroup
-
addServiceCharge2
public OrderFdParcelable addServiceCharge2(String orderId, String serviceChargeId, boolean isAutoApplied, ResultStatus status) throws RemoteException
Add aServiceCharge
to an order with a flag if it was added automatically or not.- Specified by:
addServiceCharge2
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The order ID on which to add the service charge.serviceChargeId
- The ID of the service charge to be added to the order.isAutoApplied
- The flag indicating if service charge is applied automatically or not.- Returns:
- The updated order with the service charge added.
- Throws:
RemoteException
-
addLPMPayment
public OrderFdParcelable addLPMPayment(String orderId, PaymentFdParcelable payment, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addLPMPayment
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
updatePaymentStatus
public PaymentFdParcelable updatePaymentStatus(String orderId, PaymentFdParcelable payment, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
updatePaymentStatus
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
deleteLineItemsWithReason2
public OrderFdParcelable deleteLineItemsWithReason2(String orderId, List<String> lineItemIds, String reason, ClientEventType clientEventType, String approvedByEmployeeId, ResultStatus status) throws RemoteException
- Specified by:
deleteLineItemsWithReason2
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of theOrder
from which to delete the line items.lineItemIds
- TheLineItem
IDs to delete.reason
- . Why was the line item removed?clientEventType
- optional. What app did the delete come from?approvedByEmployeeId
- . Who approved the delete request?- Returns:
- The updated
Order
. - Throws:
RemoteException
-
updatePrintGroup
public OrderFdParcelable updatePrintGroup(String orderId, PrintGroupFdParcelable fdPrintGroupToUpdate, ResultStatus status) throws RemoteException
UpdatePrintGroup
on order object.- Specified by:
updatePrintGroup
in interfaceIOrderServiceV3_1
- Parameters:
orderId
- The ID of the order to be updatedfdPrintGroupToUpdate
- PrintGroup to be updated- Returns:
- the order with updated PrintGroup
- Throws:
RemoteException
-
deletePreAuth
public OrderFdParcelable deletePreAuth(String orderId, String paymentId, VoidReason voidReason, VoidExtraData voidExtraData, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
deletePreAuth
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
voidRefund
public RefundFdParcelable voidRefund(String orderId, RefundFdParcelable fdRefund, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
voidRefund
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
voidRefundOffline
public RefundFdParcelable voidRefundOffline(String orderId, RefundFdParcelable fdRefund, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
voidRefundOffline
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
addAuthorization
public AuthorizationFdParcelable addAuthorization(String orderId, AuthorizationFdParcelable authorization, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
addAuthorization
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
captureAuthorization
public OrderFdParcelable captureAuthorization(String orderId, AuthorizationFdParcelable authorization, ResultStatus status) throws RemoteException
Not available to non-Clover apps.- Specified by:
captureAuthorization
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
partialRefundV3
public RefundFdParcelable partialRefundV3(String orderId, RefundFdParcelable fdRefund, boolean tipIncluded, ResultStatus resultStatus) throws RemoteException
Not available to non-Clover apps.- Specified by:
partialRefundV3
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
queueVoid
public OrderFdParcelable queueVoid(String orderId, String paymentId, String iccContainer, PaymentRequestCardDetails card, TransactionInfo transactionInfo, Map passThroughExtras, VoidReason reason, VoidExtraData voidExtraData, String source, ResultStatus resultStatus) throws RemoteException
Not available to non-Clover apps.- Specified by:
queueVoid
in interfaceIOrderServiceV3_1
- Throws:
RemoteException
-
asBinder
public IBinder asBinder()
- Specified by:
asBinder
in interfaceIInterface
-
-