com.clover.sdk.v3.order

Class IOrderService.Default

java.lang.Object

com.clover.sdk.v3.order.IOrderService.Default

All Implemented Interfaces:

IInterface, IOrderService

Enclosing interface:

IOrderService

public static class IOrderService.Default
extends Object
implements IOrderService

Default implementation for IOrderService.

Nested Class Summary

Nested classes/interfaces inherited from interface com.clover.sdk.v3.order.IOrderService

IOrderService.Default, IOrderService.Stub

Constructor Summary

Constructors

Constructor and Description
Default()

Method Summary

Modifier and Type	Method and Description
Order	addBatchLineItemDiscounts(String orderId, List<String> lineItemIds, List<Discount> discounts, ResultStatus status)
Order	addBatchLineItemModifications(String orderId, List<String> lineItemIds, Modifier modifier, int quantity, ResultStatus status)
LineItem	addCustomLineItem(String orderId, LineItem lineItem, boolean isTaxable, ResultStatus status) Add a custom line item to an order.
Order	addDiscount(String orderId, Discount discount, ResultStatus status)
Discount	addDiscount2(String orderId, Discount discount, ResultStatus status) Just like addDiscount(java.lang.String, com.clover.sdk.v3.order.Discount, com.clover.sdk.v1.ResultStatus) but returns a Discount instead of an Order.
LineItem	addFixedPriceLineItem(String orderId, String itemId, String binName, String userData, ResultStatus status) Add a fixed-price line item to an order.
Order	addLineItemDiscount(String orderId, String lineItemId, Discount discount, ResultStatus status)
Discount	addLineItemDiscount2(String orderId, String lineItemId, Discount discount, ResultStatus status) Just like addLineItemDiscount(java.lang.String, java.lang.String, com.clover.sdk.v3.order.Discount, com.clover.sdk.v1.ResultStatus) but returns a Discount instead of an Order.
Order	addLineItemModification(String orderId, String lineItemId, Modifier modifier, ResultStatus status)
void	addOnOrderUpdatedListener(IOnOrderUpdateListener listener)
void	addOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
LineItem	addPerUnitLineItem(String orderId, String itemId, int unitQuantity, String binName, String userData, ResultStatus status) Add a per-unit line item to an order.
Order	addServiceCharge(String orderId, String serviceChargeId, ResultStatus status) Add a ServiceCharge to an order.
LineItem	addVariablePriceLineItem(String orderId, String itemId, long price, String binName, String userData, ResultStatus status) Add a variably-priced line item to the order.
IBinder	asBinder()
List<LineItem>	copyLineItems(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status)
Map	createLineItemsFrom(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, ResultStatus status)
Map	createLineItemsFrom2(String sourceOrderId, String destinationOrderId, List<String> lineItemIds, boolean copyPrinted, boolean broadcastLineItems, ResultStatus status) Just like createLineItemsFrom(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).
Order	createOrder(Order order, ResultStatus status) Create a new Order.
Order	deleteCredit(String orderId, String creditId, ResultStatus status) Not implemented.
Order	deleteDiscounts(String orderId, List<String> discountIds, ResultStatus status)
Order	deleteLineItemDiscounts(String orderId, String lineItemId, List<String> discountIds, ResultStatus status)
Order	deleteLineItemModifications(String orderId, String lineItemId, List<String> modificationIds, ResultStatus status)
Order	deleteLineItems(String orderId, List<String> lineItemIds, ResultStatus status) Delete LineItems from an Order.
boolean	deleteOrder(String orderId, ResultStatus status) Delete an Order.
boolean	deleteOrder2(String orderId, boolean allowDeleteIfLineItemPrinted, ResultStatus status) Just like deleteOrder(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	deleteOrderOnline(String orderId, ResultStatus status) Delete an Order synchronously on the server.
Order	deleteRefund(String orderId, String refundId, ResultStatus status) Not implemented.
Order	deleteServiceCharge(String orderId, String serviceChargeId, ResultStatus status) Add a ServiceCharge to an order.
LineItem	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 like fire(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.
Order	getOrder(String orderId, ResultStatus status) Get the Order for the given ID.
List<Order>	getOrders(List<String> orderIds, ResultStatus status)
List<Payment>	getPendingPayments(ResultStatus status) This pulls pending payments from the local device db
void	removeOnOrderUpdatedListener(IOnOrderUpdateListener listener)
void	removeOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
Order	setLineItemNote(String orderId, String lineItemId, String note, ResultStatus status)
List<LineItem>	updateLineItems(String orderId, List<LineItem> lineItemIds, ResultStatus status) Update LineItems on an Order.
Order	updateOrder(Order order, ResultStatus status) Update an Order.

Methods inherited from class java.lang.Object

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

Constructor Detail

Default

public Default()

Method Detail

addOnOrderUpdatedListener

public void addOnOrderUpdatedListener(IOnOrderUpdateListener listener)
                               throws RemoteException

Specified by:

addOnOrderUpdatedListener in interface IOrderService

Throws:

RemoteException

removeOnOrderUpdatedListener

public void removeOnOrderUpdatedListener(IOnOrderUpdateListener listener)
                                  throws RemoteException

Specified by:

removeOnOrderUpdatedListener in interface IOrderService

Throws:

RemoteException

getOrder

public Order getOrder(String orderId,
                      ResultStatus status)
               throws RemoteException

Get the Order for the given ID. If the order is not synchronized on this device, the order is fetched from the server.

Specified by:

getOrder in interface IOrderService

Parameters:

orderId - The ID of the Order to retrieve.

Returns:

The Orders corresponding to the provided ID, or 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 List<Order> getOrders(List<String> orderIds,
                             ResultStatus status)
                      throws RemoteException

Specified by:

getOrders in interface IOrderService

Throws:

RemoteException

createOrder

public Order createOrder(Order order,
                         ResultStatus status)
                  throws RemoteException

Create a new Order. Only the order title is used for creation; all other fields are ignored. The following fields are set automatically:

• 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.

This method requires ORDERS_W permission.

Specified by:

createOrder in interface IOrderService

Parameters:

order - The order to create.

Throws:

RemoteException

updateOrder

public Order updateOrder(Order order,
                         ResultStatus status)
                  throws RemoteException

Update an Order. The following fields may be updated,

• total
• title
• note
• state
• taxRemoved
• groupLineItems
• manualTransactions
• testMode
• orderType.id
• customerId
• payType
• createdTime
• employee.id

All other fields are ignored. This method requires ORDERS_W permission.

Specified by:

updateOrder in interface IOrderService

Parameters:

order - The Order to updated.

Throws:

RemoteException

deleteOrder

public boolean deleteOrder(String orderId,
                           ResultStatus status)
                    throws RemoteException

Delete an Order.

Specified by:

deleteOrder in interface IOrderService

Parameters:

orderId - The ID of the Order 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 Order addServiceCharge(String orderId,
                              String serviceChargeId,
                              ResultStatus status)
                       throws RemoteException

Add a ServiceCharge to an order.

Specified by:

addServiceCharge in interface IOrderService

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 Order deleteServiceCharge(String orderId,
                                 String serviceChargeId,
                                 ResultStatus status)
                          throws RemoteException

Add a ServiceCharge to an order.

Specified by:

deleteServiceCharge in interface IOrderService

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 LineItem 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. LineItems are linked to Items with an item ID. Think of the Item as a template for creating a LineItem, and a LineItem as the order's copy of an Item.

Specified by:

addFixedPriceLineItem in interface IOrderService

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 null.

userData - Meta-data to attach to the line item. May be null.

Returns:

The newly created LineItem.

Throws:

RemoteException

addPerUnitLineItem

public LineItem 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). LineItems are linked to Items with an item ID. Think of the Item as a template for creating a LineItem, and a LineItem as the order's copy of an Item.

Specified by:

addPerUnitLineItem in interface IOrderService

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 null.

userData - Meta-data to attach to the line item. May be null.

Returns:

The newly created LineItem.

Throws:

RemoteException

addVariablePriceLineItem

public LineItem 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 a LineItem. All other methods return the complete, updated Order.

Specified by:

addVariablePriceLineItem in interface IOrderService

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 null.

userData - Meta-data to attach to the line item. May be null.

Throws:

RemoteException

addCustomLineItem

public LineItem addCustomLineItem(String orderId,
                                  LineItem lineItem,
                                  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 a LineItem. All other methods return the complete, updated Order.

Specified by:

addCustomLineItem in interface IOrderService

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 List<LineItem> updateLineItems(String orderId,
                                      List<LineItem> lineItemIds,
                                      ResultStatus status)
                               throws RemoteException

Update LineItems on an Order. Only the following fields may be updated,

• binName
• printed
• note
• userData

All other fields are ignored.

Specified by:

updateLineItems in interface IOrderService

Parameters:

orderId - The ID of the order on which to update the line items.

lineItemIds - The LineItems to update on the order.

Returns:

The updated LineItems.

Throws:

RemoteException

deleteLineItems

public Order deleteLineItems(String orderId,
                             List<String> lineItemIds,
                             ResultStatus status)
                      throws RemoteException

Delete LineItems from an Order.

Specified by:

deleteLineItems in interface IOrderService

Parameters:

orderId - The ID of the Order from which to delete the line items.

lineItemIds - The LineItem IDs to delete.

Returns:

The updated Order.

Throws:

RemoteException

copyLineItems

public List<LineItem> copyLineItems(String sourceOrderId,
                                    String destinationOrderId,
                                    List<String> lineItemIds,
                                    ResultStatus status)
                             throws RemoteException

Specified by:

copyLineItems in interface IOrderService

Throws:

RemoteException

setLineItemNote

public Order setLineItemNote(String orderId,
                             String lineItemId,
                             String note,
                             ResultStatus status)
                      throws RemoteException

Specified by:

setLineItemNote in interface IOrderService

Throws:

RemoteException

addLineItemModification

public Order addLineItemModification(String orderId,
                                     String lineItemId,
                                     Modifier modifier,
                                     ResultStatus status)
                              throws RemoteException

Specified by:

addLineItemModification in interface IOrderService

Throws:

RemoteException

deleteLineItemModifications

public Order deleteLineItemModifications(String orderId,
                                         String lineItemId,
                                         List<String> modificationIds,
                                         ResultStatus status)
                                  throws RemoteException

Specified by:

deleteLineItemModifications in interface IOrderService

Throws:

RemoteException

exchangeItem

public LineItem exchangeItem(String orderId,
                             String oldLineItemId,
                             String itemId,
                             String binName,
                             String userData,
                             ResultStatus status)
                      throws RemoteException

Specified by:

exchangeItem in interface IOrderService

Throws:

RemoteException

addDiscount

public Order addDiscount(String orderId,
                         Discount discount,
                         ResultStatus status)
                  throws RemoteException

Specified by:

addDiscount in interface IOrderService

Throws:

RemoteException

deleteDiscounts

public Order deleteDiscounts(String orderId,
                             List<String> discountIds,
                             ResultStatus status)
                      throws RemoteException

Specified by:

deleteDiscounts in interface IOrderService

Throws:

RemoteException

addLineItemDiscount

public Order addLineItemDiscount(String orderId,
                                 String lineItemId,
                                 Discount discount,
                                 ResultStatus status)
                          throws RemoteException

Specified by:

addLineItemDiscount in interface IOrderService

Throws:

RemoteException

deleteLineItemDiscounts

public Order deleteLineItemDiscounts(String orderId,
                                     String lineItemId,
                                     List<String> discountIds,
                                     ResultStatus status)
                              throws RemoteException

Specified by:

deleteLineItemDiscounts in interface IOrderService

Throws:

RemoteException

deleteCredit

public Order deleteCredit(String orderId,
                          String creditId,
                          ResultStatus status)
                   throws RemoteException

Not implemented.

Specified by:

deleteCredit in interface IOrderService

Throws:

RemoteException

deleteRefund

public Order deleteRefund(String orderId,
                          String refundId,
                          ResultStatus status)
                   throws RemoteException

Not implemented.

Specified by:

deleteRefund in interface IOrderService

Throws:

RemoteException

deleteOrderOnline

public boolean deleteOrderOnline(String orderId,
                                 ResultStatus status)
                          throws RemoteException

Delete an Order 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 interface IOrderService

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 Order addBatchLineItemModifications(String orderId,
                                           List<String> lineItemIds,
                                           Modifier modifier,
                                           int quantity,
                                           ResultStatus status)
                                    throws RemoteException

Specified by:

addBatchLineItemModifications in interface IOrderService

Throws:

RemoteException

addBatchLineItemDiscounts

public Order addBatchLineItemDiscounts(String orderId,
                                       List<String> lineItemIds,
                                       List<Discount> discounts,
                                       ResultStatus status)
                                throws RemoteException

Specified by:

addBatchLineItemDiscounts in interface IOrderService

Throws:

RemoteException

createLineItemsFrom

public Map createLineItemsFrom(String sourceOrderId,
                               String destinationOrderId,
                               List<String> lineItemIds,
                               ResultStatus status)
                        throws RemoteException

Specified by:

createLineItemsFrom in interface IOrderService

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 interface IOrderService

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

addOnOrderUpdatedListener2

public void addOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
                                throws RemoteException

Specified by:

addOnOrderUpdatedListener2 in interface IOrderService

Throws:

RemoteException

removeOnOrderUpdatedListener2

public void removeOnOrderUpdatedListener2(IOnOrderUpdateListener2 listener)
                                   throws RemoteException

Specified by:

removeOnOrderUpdatedListener2 in interface IOrderService

Throws:

RemoteException

addDiscount2

public Discount addDiscount2(String orderId,
                             Discount discount,
                             ResultStatus status)
                      throws RemoteException

Just like addDiscount(java.lang.String, com.clover.sdk.v3.order.Discount, com.clover.sdk.v1.ResultStatus) but returns a Discount instead of an Order.

Specified by:

addDiscount2 in interface IOrderService

Throws:

RemoteException

addLineItemDiscount2

public Discount addLineItemDiscount2(String orderId,
                                     String lineItemId,
                                     Discount discount,
                                     ResultStatus status)
                              throws RemoteException

Just like addLineItemDiscount(java.lang.String, java.lang.String, com.clover.sdk.v3.order.Discount, com.clover.sdk.v1.ResultStatus) but returns a Discount instead of an Order.

Specified by:

addLineItemDiscount2 in interface IOrderService

Throws:

RemoteException

fire2

public boolean fire2(String sourceOrderid,
                     boolean requireAllItems,
                     ResultStatus status)
              throws RemoteException

Just like fire(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 interface IOrderService

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 Map createLineItemsFrom2(String sourceOrderId,
                                String destinationOrderId,
                                List<String> lineItemIds,
                                boolean copyPrinted,
                                boolean broadcastLineItems,
                                ResultStatus status)
                         throws RemoteException

Just like createLineItemsFrom(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 interface IOrderService

Throws:

RemoteException

deleteOrder2

public boolean deleteOrder2(String orderId,
                            boolean allowDeleteIfLineItemPrinted,
                            ResultStatus status)
                     throws RemoteException

Just like deleteOrder(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 interface IOrderService

Throws:

RemoteException

getPendingPayments

public List<Payment> getPendingPayments(ResultStatus status)
                                 throws RemoteException

This pulls pending payments from the local device db

Specified by:

getPendingPayments in interface IOrderService

Throws:

RemoteException

asBinder

public IBinder asBinder()

Specified by:

asBinder in interface IInterface