com.clover.sdk.v3.order

Class LineItemEvents

java.lang.Object

com.clover.sdk.v3.order.LineItemEvents

public class LineItemEvents
extends Object

This class provides an interface creating and reading LineItemEvents. To query LineItemEvents use ContentResolver.query(Uri, String[], String, String[], String). See LineItemEventContract. This class is a thin wrapper over the content provider call methods defined in LineItemEventContract. Consumers should prefer this simpler interface however.

See Also:

LineItemEvent, LineItemEventContract

Constructor Summary

Constructors

Constructor and Description
LineItemEvents(Context context)

Method Summary

Modifier and Type	Method and Description
int	bulkInsert(Collection<LineItemEvent> events) Insert new line item events.
LineItemEvent	insert(LineItemEvent event) Insert a new line item event.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineItemEvents

public LineItemEvents(Context context)

Method Detail

insert

public LineItemEvent insert(LineItemEvent event)
                     throws ClientException

Insert a new line item event. Do not set the ID of the event. The ID will be available in the returned LineItemEvent.

Returns:

The created LineItemEvent. The returned LineItemEvent will have its UUID set.

Throws:

ClientException - if the event could not be inserted. Inspect ResultStatusException.getResultStatus() to understand the reason.

See Also:

LineItemEventContract.METHOD_INSERT

bulkInsert

public int bulkInsert(Collection<LineItemEvent> events)
               throws ClientException

Insert new line item events. Either all events are inserted, or none if a failure occurs. Do not set the IDs of the events as they will be generated automatically. Query the ContentProvider using LineItemEventContract to get a list of LineItemEvents.

Parameters:

events - a collection of events to create.

Returns:

The number of events created. This will always be equal to events.size().

Throws:

ClientException - if an event could not be inserted, in which case no events will be inserted. Inspect ResultStatusException.getResultStatus() to understand the reason.

See Also:

LineItemEventContract.METHOD_BULK_INSERT