Package 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 methodMETHOD_INSERT
, or the methodLineItemEvents.insert(LineItemEvent)
. To insert several line item events at once, prefer the content provider call methodMETHOD_BULK_INSERT
, or the methodLineItemEvents.bulkInsert(Collection)
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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 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_FROM_LINE_ITEM_ID
static String
EXTRA_LINE_ITEM_EVENT
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
AString
that is aLineItemEvent
ID.static String
EXTRA_LINE_ITEM_EVENTS
An ArrayList ofLineItemEvent
.static String
EXTRA_ORDER_ID
AString
, the 13-character Clover order UUID corresponding to this event.static String
EXTRA_RESULT_STATUS
AResultStatus
, the result of the operation.static String
EXTRA_TO_LINE_ITEM_ID
static String
METHOD_BULK_INSERT
Content provider call (ContentResolver.call(Uri, String, String, Bundle)
method to insert an ArrayList ofLineItemEvent
.static String
METHOD_COPY_EVENTS
Content provider call (ContentResolver.call(Uri, String, String, Bundle)
method to copy list ofLineItemEvent
to new line item events.static String
METHOD_GET
Content provider call (ContentResolver.call(Uri, String, String, Bundle)
method to retrieve aLineItemEvent
.static String
METHOD_INSERT
Content provider call (ContentResolver.call(Uri, String, String, Bundle)
method to insert aLineItemEvent
.
-
Constructor Summary
Constructors Constructor Description LineItemEventContract()
-
-
-
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 aLineItemEvent
. This method requires that extraEXTRA_LINE_ITEM_EVENT
is included in the call extras. The result bundle will contain aResultStatus
at extraEXTRA_RESULT_STATUS
to indicate the result of the operation. Prefer to useLineItemEvents.insert(LineItemEvent)
to insert line item events.
-
METHOD_COPY_EVENTS
public static final String METHOD_COPY_EVENTS
Content provider call (ContentResolver.call(Uri, String, String, Bundle)
method to copy list ofLineItemEvent
to new line item events. This method requires that extraEXTRA_FROM_LINE_ITEM_ID
EXTRA_TO_LINE_ITEM_ID
is included in the call extras.The result bundle will contain a
ResultStatus
at extraEXTRA_RESULT_STATUS
to indicate the result of the operation. Prefer to useLineItemEvents.copyLineItemEvents(String, String, String)
to copy line item events.
-
METHOD_BULK_INSERT
public static final String METHOD_BULK_INSERT
Content provider call (ContentResolver.call(Uri, String, String, Bundle)
method to insert an ArrayList ofLineItemEvent
. Only one change notification is sent when the operation is successful. This method requires that extraEXTRA_LINE_ITEM_EVENTS
is included in the call extras and is anArrayList<LineItemEvent>
. The result bundle will contain aResultStatus
at extraEXTRA_RESULT_STATUS
to indicate the result of the operation. Prefer to useLineItemEvents.bulkInsert(Collection)
to insert many line item events.
-
METHOD_GET
public static final String METHOD_GET
Content provider call (ContentResolver.call(Uri, String, String, Bundle)
method to retrieve aLineItemEvent
. This method requires that extraEXTRA_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 usingContentResolver.query(Uri, String[], String, String[], String)
to obtain line item events of interest. Prefer to useLineItemEvents.get(String)
to get a line item event. The result bundle will contain aResultStatus
at extraEXTRA_RESULT_STATUS
to indicate the result of the operation, and ifResultStatus.isSuccess()
returns true, aLineItemEvent
at extraEXTRA_LINE_ITEM_EVENT
.
-
EXTRA_LINE_ITEM_EVENT
public static final String EXTRA_LINE_ITEM_EVENT
- See Also:
- Constant Field Values
-
EXTRA_LINE_ITEM_EVENTS
public static final String EXTRA_LINE_ITEM_EVENTS
An ArrayList ofLineItemEvent
.- 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 toMETHOD_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
AString
that is aLineItemEvent
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
AResultStatus
, the result of the operation.- See Also:
- Constant Field Values
-
EXTRA_FROM_LINE_ITEM_ID
public static final String EXTRA_FROM_LINE_ITEM_ID
- See Also:
- Constant Field Values
-
EXTRA_TO_LINE_ITEM_ID
public static final String EXTRA_TO_LINE_ITEM_ID
- See Also:
- Constant Field Values
-
EXTRA_ORDER_ID
public static final String EXTRA_ORDER_ID
AString
, the 13-character Clover order UUID corresponding to this event.- See Also:
- Constant Field Values
-
-