com.clover.sdk.v3.order

Class LineItemEventContract

java.lang.Object

com.clover.sdk.v3.order.LineItemEventContract

public final class LineItemEventContract
extends Object

This class defines the contract for accessing the line item events content provider. This content provider does not support updates or deletes. To insert a single line item event, use the content provider call method METHOD_INSERT, or the method LineItemEvents.insert(LineItemEvent). To insert several line item events at once, prefer the content provider call method METHOD_BULK_INSERT, or the method LineItemEvents.bulkInsert(Collection).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LineItemEventContract.LineItemEvents The contract for accessing the line item events table in this content provider.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHORITY Content provider authority for accessing the line item events content provider.
static Uri	AUTHORITY_URI Content provider authority URI for accessing the line item events content provider.
static String	EXTRA_LINE_ITEM_EVENT A LineItemEvent.
static String	EXTRA_LINE_ITEM_EVENT_COUNT A return value of the number of line item events created after a bulk insert.
static String	EXTRA_LINE_ITEM_EVENT_UUID A String that is a LineItemEvent ID.
static String	EXTRA_LINE_ITEM_EVENTS An ArrayList of LineItemEvent.
static String	EXTRA_RESULT_STATUS A ResultStatus, the result of the operation.
static String	METHOD_BULK_INSERT Content provider call (ContentResolver.call(Uri, String, String, Bundle) method to insert an ArrayList of LineItemEvent.
static String	METHOD_GET Content provider call (ContentResolver.call(Uri, String, String, Bundle) method to retrieve a LineItemEvent.
static String	METHOD_INSERT Content provider call (ContentResolver.call(Uri, String, String, Bundle) method to insert a LineItemEvent.

Constructor Summary

Constructors

Constructor and Description
LineItemEventContract()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

AUTHORITY

public static final String AUTHORITY

Content provider authority for accessing the line item events content provider.

See Also:

Constant Field Values

AUTHORITY_URI

public static final Uri AUTHORITY_URI

Content provider authority URI for accessing the line item events content provider.

METHOD_INSERT

public static final String METHOD_INSERT

Content provider call (ContentResolver.call(Uri, String, String, Bundle) method to insert a LineItemEvent. This method requires that extra EXTRA_LINE_ITEM_EVENT is included in the call extras. The result bundle will contain a ResultStatus at extra EXTRA_RESULT_STATUS to indicate the result of the operation. Prefer to use LineItemEvents.insert(LineItemEvent) to insert line item events.

See Also:

ContentResolver.call(Uri, String, String, Bundle), LineItemEvent, ResultStatus, EXTRA_RESULT_STATUS, EXTRA_LINE_ITEM_EVENT, Constant Field Values

METHOD_BULK_INSERT

public static final String METHOD_BULK_INSERT

Content provider call (ContentResolver.call(Uri, String, String, Bundle) method to insert an ArrayList of LineItemEvent. Only one change notification is sent when the operation is successful. This method requires that extra EXTRA_LINE_ITEM_EVENTS is included in the call extras and is an ArrayList<LineItemEvent>. The result bundle will contain a ResultStatus at extra EXTRA_RESULT_STATUS to indicate the result of the operation. Prefer to use LineItemEvents.bulkInsert(Collection) to insert many line item events.

See Also:

ContentResolver.call(Uri, String, String, Bundle), LineItemEvent, ResultStatus, EXTRA_RESULT_STATUS, EXTRA_LINE_ITEM_EVENTS, EXTRA_LINE_ITEM_EVENT_COUNT, Constant Field Values

METHOD_GET

public static final String METHOD_GET

Content provider call (ContentResolver.call(Uri, String, String, Bundle) method to retrieve a LineItemEvent. This method requires that extra EXTRA_LINE_ITEM_EVENT_UUID is included in the call extras. In most cases fetching a single line item event by UUID won't be useful. Consider using ContentResolver.query(Uri, String[], String, String[], String) to obtain line item events of interest. Prefer to use LineItemEvents.get(String) to get a line item event. The result bundle will contain a ResultStatus at extra EXTRA_RESULT_STATUS to indicate the result of the operation, and if ResultStatus.isSuccess() returns true, a LineItemEvent at extra EXTRA_LINE_ITEM_EVENT.

See Also:

ContentResolver.call(Uri, String, String, Bundle), LineItemEvent, ResultStatus, EXTRA_RESULT_STATUS, EXTRA_LINE_ITEM_EVENT_UUID, EXTRA_LINE_ITEM_EVENT, Constant Field Values

EXTRA_LINE_ITEM_EVENT

public static final String EXTRA_LINE_ITEM_EVENT

A LineItemEvent.

See Also:

Constant Field Values

EXTRA_LINE_ITEM_EVENTS

public static final String EXTRA_LINE_ITEM_EVENTS

An ArrayList of LineItemEvent.

See Also:

Constant Field Values

EXTRA_LINE_ITEM_EVENT_COUNT

public static final String EXTRA_LINE_ITEM_EVENT_COUNT

A return value of the number of line item events created after a bulk insert. Only valid in the result bundle of a call to METHOD_BULK_INSERT. If a call is successful, this count will always be equal to the number of events in the request.

See Also:

Constant Field Values

EXTRA_LINE_ITEM_EVENT_UUID

public static final String EXTRA_LINE_ITEM_EVENT_UUID

A String that is a LineItemEvent ID. This value must be a 13-character Clover UUID.

See Also:

Constant Field Values

EXTRA_RESULT_STATUS

public static final String EXTRA_RESULT_STATUS

A ResultStatus, the result of the operation.

See Also:

Constant Field Values

Constructor Detail

LineItemEventContract

public LineItemEventContract()