Package com.clover.sdk.v3.order
Class VoidedLineItem
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.order.VoidedLineItem
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class VoidedLineItem extends GenericParcelable implements Validator, JSONifiable
This is an auto-generated Clover data object.For reporting on a removed line item
Fields
- See Also:
IOrderService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
VoidedLineItem.Constraints
-
Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable
JSONifiable.Creator<T>
-
Nested classes/interfaces inherited from interface android.os.Parcelable
Parcelable.ClassLoaderCreator<T extends Object>, Parcelable.Creator<T extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static Parcelable.Creator<VoidedLineItem>
CREATOR
static JSONifiable.Creator<VoidedLineItem>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description VoidedLineItem()
Constructs a new empty instance.protected
VoidedLineItem(boolean noInit)
Constructs a new empty instance.VoidedLineItem(VoidedLineItem src)
Constructs a new instance that is a deep copy of the source instance.VoidedLineItem(String json)
Constructs a new instance from the given JSON String.VoidedLineItem(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearApprovedBy()
Clears the 'approvedBy' field, the 'has' method for this field will now return falsevoid
clearClientEventType()
Clears the 'clientEventType' field, the 'has' method for this field will now return falsevoid
clearCreatedBy()
Clears the 'createdBy' field, the 'has' method for this field will now return falsevoid
clearDeletedTime()
Clears the 'deletedTime' field, the 'has' method for this field will now return falsevoid
clearEnvironment()
Clears the 'environment' field, the 'has' method for this field will now return falsevoid
clearLineItem()
Clears the 'lineItem' field, the 'has' method for this field will now return falsevoid
clearMerchant()
Clears the 'merchant' field, the 'has' method for this field will now return falsevoid
clearReason()
Clears the 'reason' field, the 'has' method for this field will now return falsevoid
clearRemovedBy()
Clears the 'removedBy' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.VoidedLineItem
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.Reference
getApprovedBy()
Optional info about employee who approved deletion of line item in case current employee does not have the permissionClientEventType
getClientEventType()
What event on the client removed this? Was it because of moving a table? Or was it plain old deleting a line item?Reference
getCreatedBy()
Employee who created the order from which the line item was voidedLong
getDeletedTime()
Timestamp of when this line item was deletedString
getEnvironment()
Which environment was this recorded inprotected GenericClient
getGenericClient()
JSONObject
getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.LineItem
getLineItem()
The line item that was voidedReference
getMerchant()
String
getReason()
Why was the line item voidedReference
getRemovedBy()
Employee who voided the itemboolean
hasApprovedBy()
Checks whether the 'approvedBy' field has been set, however the value could be nullboolean
hasClientEventType()
Checks whether the 'clientEventType' field has been set, however the value could be nullboolean
hasCreatedBy()
Checks whether the 'createdBy' field has been set, however the value could be nullboolean
hasDeletedTime()
Checks whether the 'deletedTime' field has been set, however the value could be nullboolean
hasEnvironment()
Checks whether the 'environment' field has been set, however the value could be nullboolean
hasLineItem()
Checks whether the 'lineItem' field has been set, however the value could be nullboolean
hasMerchant()
Checks whether the 'merchant' field has been set, however the value could be nullboolean
hasReason()
Checks whether the 'reason' field has been set, however the value could be nullboolean
hasRemovedBy()
Checks whether the 'removedBy' field has been set, however the value could be nullboolean
isNotNullApprovedBy()
Checks whether the 'approvedBy' field is set and is not nullboolean
isNotNullClientEventType()
Checks whether the 'clientEventType' field is set and is not nullboolean
isNotNullCreatedBy()
Checks whether the 'createdBy' field is set and is not nullboolean
isNotNullDeletedTime()
Checks whether the 'deletedTime' field is set and is not nullboolean
isNotNullEnvironment()
Checks whether the 'environment' field is set and is not nullboolean
isNotNullLineItem()
Checks whether the 'lineItem' field is set and is not nullboolean
isNotNullMerchant()
Checks whether the 'merchant' field is set and is not nullboolean
isNotNullReason()
Checks whether the 'reason' field is set and is not nullboolean
isNotNullRemovedBy()
Checks whether the 'removedBy' field is set and is not nullvoid
mergeChanges(VoidedLineItem src)
Copy all the changed fields from the given source to this instance.void
resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.VoidedLineItem
setApprovedBy(Reference approvedBy)
Sets the field 'approvedBy'.VoidedLineItem
setClientEventType(ClientEventType clientEventType)
Sets the field 'clientEventType'.VoidedLineItem
setCreatedBy(Reference createdBy)
Sets the field 'createdBy'.VoidedLineItem
setDeletedTime(Long deletedTime)
Sets the field 'deletedTime'.VoidedLineItem
setEnvironment(String environment)
Sets the field 'environment'.VoidedLineItem
setLineItem(LineItem lineItem)
Sets the field 'lineItem'.VoidedLineItem
setMerchant(Reference merchant)
Sets the field 'merchant'.VoidedLineItem
setReason(String reason)
Sets the field 'reason'.VoidedLineItem
setRemovedBy(Reference removedBy)
Sets the field 'removedBy'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<VoidedLineItem> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<VoidedLineItem> JSON_CREATOR
-
-
Constructor Detail
-
VoidedLineItem
public VoidedLineItem()
Constructs a new empty instance.
-
VoidedLineItem
protected VoidedLineItem(boolean noInit)
Constructs a new empty instance.
-
VoidedLineItem
public VoidedLineItem(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
VoidedLineItem
public VoidedLineItem(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
VoidedLineItem
public VoidedLineItem(VoidedLineItem src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getLineItem
public LineItem getLineItem()
The line item that was voided
-
getMerchant
public Reference getMerchant()
-
getReason
public String getReason()
Why was the line item voided
-
getRemovedBy
public Reference getRemovedBy()
Employee who voided the item
-
getApprovedBy
public Reference getApprovedBy()
Optional info about employee who approved deletion of line item in case current employee does not have the permission
-
getCreatedBy
public Reference getCreatedBy()
Employee who created the order from which the line item was voided
-
getDeletedTime
public Long getDeletedTime()
Timestamp of when this line item was deleted
-
getEnvironment
public String getEnvironment()
Which environment was this recorded in
-
getClientEventType
public ClientEventType getClientEventType()
What event on the client removed this? Was it because of moving a table? Or was it plain old deleting a line item?
-
getGenericClient
protected GenericClient getGenericClient()
- Specified by:
getGenericClient
in classGenericParcelable
-
getJSONObject
public JSONObject getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.- Specified by:
getJSONObject
in interfaceJSONifiable
-
isNotNullLineItem
public boolean isNotNullLineItem()
Checks whether the 'lineItem' field is set and is not null
-
isNotNullMerchant
public boolean isNotNullMerchant()
Checks whether the 'merchant' field is set and is not null
-
isNotNullReason
public boolean isNotNullReason()
Checks whether the 'reason' field is set and is not null
-
isNotNullRemovedBy
public boolean isNotNullRemovedBy()
Checks whether the 'removedBy' field is set and is not null
-
isNotNullApprovedBy
public boolean isNotNullApprovedBy()
Checks whether the 'approvedBy' field is set and is not null
-
isNotNullCreatedBy
public boolean isNotNullCreatedBy()
Checks whether the 'createdBy' field is set and is not null
-
isNotNullDeletedTime
public boolean isNotNullDeletedTime()
Checks whether the 'deletedTime' field is set and is not null
-
isNotNullEnvironment
public boolean isNotNullEnvironment()
Checks whether the 'environment' field is set and is not null
-
isNotNullClientEventType
public boolean isNotNullClientEventType()
Checks whether the 'clientEventType' field is set and is not null
-
hasLineItem
public boolean hasLineItem()
Checks whether the 'lineItem' field has been set, however the value could be null
-
hasMerchant
public boolean hasMerchant()
Checks whether the 'merchant' field has been set, however the value could be null
-
hasReason
public boolean hasReason()
Checks whether the 'reason' field has been set, however the value could be null
-
hasRemovedBy
public boolean hasRemovedBy()
Checks whether the 'removedBy' field has been set, however the value could be null
-
hasApprovedBy
public boolean hasApprovedBy()
Checks whether the 'approvedBy' field has been set, however the value could be null
-
hasCreatedBy
public boolean hasCreatedBy()
Checks whether the 'createdBy' field has been set, however the value could be null
-
hasDeletedTime
public boolean hasDeletedTime()
Checks whether the 'deletedTime' field has been set, however the value could be null
-
hasEnvironment
public boolean hasEnvironment()
Checks whether the 'environment' field has been set, however the value could be null
-
hasClientEventType
public boolean hasClientEventType()
Checks whether the 'clientEventType' field has been set, however the value could be null
-
setLineItem
public VoidedLineItem setLineItem(LineItem lineItem)
Sets the field 'lineItem'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setMerchant
public VoidedLineItem setMerchant(Reference merchant)
Sets the field 'merchant'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setReason
public VoidedLineItem setReason(String reason)
Sets the field 'reason'.
-
setRemovedBy
public VoidedLineItem setRemovedBy(Reference removedBy)
Sets the field 'removedBy'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setApprovedBy
public VoidedLineItem setApprovedBy(Reference approvedBy)
Sets the field 'approvedBy'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setCreatedBy
public VoidedLineItem setCreatedBy(Reference createdBy)
Sets the field 'createdBy'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setDeletedTime
public VoidedLineItem setDeletedTime(Long deletedTime)
Sets the field 'deletedTime'.
-
setEnvironment
public VoidedLineItem setEnvironment(String environment)
Sets the field 'environment'.
-
setClientEventType
public VoidedLineItem setClientEventType(ClientEventType clientEventType)
Sets the field 'clientEventType'.
-
clearLineItem
public void clearLineItem()
Clears the 'lineItem' field, the 'has' method for this field will now return false
-
clearMerchant
public void clearMerchant()
Clears the 'merchant' field, the 'has' method for this field will now return false
-
clearReason
public void clearReason()
Clears the 'reason' field, the 'has' method for this field will now return false
-
clearRemovedBy
public void clearRemovedBy()
Clears the 'removedBy' field, the 'has' method for this field will now return false
-
clearApprovedBy
public void clearApprovedBy()
Clears the 'approvedBy' field, the 'has' method for this field will now return false
-
clearCreatedBy
public void clearCreatedBy()
Clears the 'createdBy' field, the 'has' method for this field will now return false
-
clearDeletedTime
public void clearDeletedTime()
Clears the 'deletedTime' field, the 'has' method for this field will now return false
-
clearEnvironment
public void clearEnvironment()
Clears the 'environment' field, the 'has' method for this field will now return false
-
clearClientEventType
public void clearClientEventType()
Clears the 'clientEventType' field, the 'has' method for this field will now return false
-
containsChanges
public boolean containsChanges()
Returns true if this instance has any changes.
-
resetChangeLog
public void resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
-
copyChanges
public VoidedLineItem copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(VoidedLineItem src)
Copy all the changed fields from the given source to this instance.
-
-