Package com.clover.sdk.v3.order
Class PrintGroup
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.order.PrintGroup
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class PrintGroup extends GenericParcelable implements Validator, JSONifiable
This is an auto-generated Clover data object.Groups together a set of line items to display under a heading on receipts.
Fields
- See Also:
IOrderService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PrintGroup.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<PrintGroup>
CREATOR
static JSONifiable.Creator<PrintGroup>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description PrintGroup()
Constructs a new empty instance.protected
PrintGroup(boolean noInit)
Constructs a new empty instance.PrintGroup(PrintGroup src)
Constructs a new instance that is a deep copy of the source instance.PrintGroup(String json)
Constructs a new instance from the given JSON String.PrintGroup(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
clearDeviceId()
Clears the 'deviceId' field, the 'has' method for this field will now return falsevoid
clearFired()
Clears the 'fired' field, the 'has' method for this field will now return falsevoid
clearId()
Clears the 'id' field, the 'has' method for this field will now return falsevoid
clearName()
Clears the 'name' field, the 'has' method for this field will now return falsevoid
clearPrintTime()
Clears the 'printTime' field, the 'has' method for this field will now return falsevoid
clearSortOrder()
Clears the 'sortOrder' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.PrintGroup
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.String
getDeviceId()
Device id of the device where the course is createdBoolean
getFired()
True if this print group has been sent to an order printer.protected GenericClient
getGenericClient()
String
getId()
Unique identifier.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.String
getName()
The print group heading that will be displayed on receipts.Long
getPrintTime()
Timestamp of when this print group should print or had printed relative to the merchant's Clover device system time.Integer
getSortOrder()
The order in which this print group is displayed relative to other print groups on the same receipt.boolean
hasDeviceId()
Checks whether the 'deviceId' field has been set, however the value could be nullboolean
hasFired()
Checks whether the 'fired' field has been set, however the value could be nullboolean
hasId()
Checks whether the 'id' field has been set, however the value could be nullboolean
hasName()
Checks whether the 'name' field has been set, however the value could be nullboolean
hasPrintTime()
Checks whether the 'printTime' field has been set, however the value could be nullboolean
hasSortOrder()
Checks whether the 'sortOrder' field has been set, however the value could be nullboolean
isNotNullDeviceId()
Checks whether the 'deviceId' field is set and is not nullboolean
isNotNullFired()
Checks whether the 'fired' field is set and is not nullboolean
isNotNullId()
Checks whether the 'id' field is set and is not nullboolean
isNotNullName()
Checks whether the 'name' field is set and is not nullboolean
isNotNullPrintTime()
Checks whether the 'printTime' field is set and is not nullboolean
isNotNullSortOrder()
Checks whether the 'sortOrder' field is set and is not nullvoid
mergeChanges(PrintGroup 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.PrintGroup
setDeviceId(String deviceId)
Sets the field 'deviceId'.PrintGroup
setFired(Boolean fired)
Sets the field 'fired'.PrintGroup
setId(String id)
Sets the field 'id'.PrintGroup
setName(String name)
Sets the field 'name'.PrintGroup
setPrintTime(Long printTime)
Sets the field 'printTime'.PrintGroup
setSortOrder(Integer sortOrder)
Sets the field 'sortOrder'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<PrintGroup> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<PrintGroup> JSON_CREATOR
-
-
Constructor Detail
-
PrintGroup
public PrintGroup()
Constructs a new empty instance.
-
PrintGroup
protected PrintGroup(boolean noInit)
Constructs a new empty instance.
-
PrintGroup
public PrintGroup(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
PrintGroup
public PrintGroup(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.
-
PrintGroup
public PrintGroup(PrintGroup src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getId
public String getId()
Unique identifier.
-
getName
public String getName()
The print group heading that will be displayed on receipts.
-
getSortOrder
public Integer getSortOrder()
The order in which this print group is displayed relative to other print groups on the same receipt. Print groups with identical sort orders will be ordered by name.
-
getFired
public Boolean getFired()
True if this print group has been sent to an order printer.
-
getPrintTime
public Long getPrintTime()
Timestamp of when this print group should print or had printed relative to the merchant's Clover device system time.
-
getDeviceId
public String getDeviceId()
Device id of the device where the course is created
-
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
-
isNotNullId
public boolean isNotNullId()
Checks whether the 'id' field is set and is not null
-
isNotNullName
public boolean isNotNullName()
Checks whether the 'name' field is set and is not null
-
isNotNullSortOrder
public boolean isNotNullSortOrder()
Checks whether the 'sortOrder' field is set and is not null
-
isNotNullFired
public boolean isNotNullFired()
Checks whether the 'fired' field is set and is not null
-
isNotNullPrintTime
public boolean isNotNullPrintTime()
Checks whether the 'printTime' field is set and is not null
-
isNotNullDeviceId
public boolean isNotNullDeviceId()
Checks whether the 'deviceId' field is set and is not null
-
hasId
public boolean hasId()
Checks whether the 'id' field has been set, however the value could be null
-
hasName
public boolean hasName()
Checks whether the 'name' field has been set, however the value could be null
-
hasSortOrder
public boolean hasSortOrder()
Checks whether the 'sortOrder' field has been set, however the value could be null
-
hasFired
public boolean hasFired()
Checks whether the 'fired' field has been set, however the value could be null
-
hasPrintTime
public boolean hasPrintTime()
Checks whether the 'printTime' field has been set, however the value could be null
-
hasDeviceId
public boolean hasDeviceId()
Checks whether the 'deviceId' field has been set, however the value could be null
-
setId
public PrintGroup setId(String id)
Sets the field 'id'.
-
setName
public PrintGroup setName(String name)
Sets the field 'name'.
-
setSortOrder
public PrintGroup setSortOrder(Integer sortOrder)
Sets the field 'sortOrder'.
-
setFired
public PrintGroup setFired(Boolean fired)
Sets the field 'fired'.
-
setPrintTime
public PrintGroup setPrintTime(Long printTime)
Sets the field 'printTime'.
-
setDeviceId
public PrintGroup setDeviceId(String deviceId)
Sets the field 'deviceId'.
-
clearId
public void clearId()
Clears the 'id' field, the 'has' method for this field will now return false
-
clearName
public void clearName()
Clears the 'name' field, the 'has' method for this field will now return false
-
clearSortOrder
public void clearSortOrder()
Clears the 'sortOrder' field, the 'has' method for this field will now return false
-
clearFired
public void clearFired()
Clears the 'fired' field, the 'has' method for this field will now return false
-
clearPrintTime
public void clearPrintTime()
Clears the 'printTime' field, the 'has' method for this field will now return false
-
clearDeviceId
public void clearDeviceId()
Clears the 'deviceId' 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 PrintGroup copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(PrintGroup src)
Copy all the changed fields from the given source to this instance.
-
-