Package com.clover.sdk.v3.inventory
Class Tag
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.inventory.Tag
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class Tag extends GenericParcelable implements Validator, JSONifiable
- See Also:
IInventoryService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Tag.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<Tag>
CREATOR
static JSONifiable.Creator<Tag>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description Tag()
Constructs a new empty instance.protected
Tag(boolean noInit)
Constructs a new empty instance.Tag(Tag src)
Constructs a new instance that is a deep copy of the source instance.Tag(String json)
Constructs a new instance from the given JSON String.Tag(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
clearId()
Clears the 'id' field, the 'has' method for this field will now return falsevoid
clearItems()
Clears the 'items' 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
clearPrinters()
Clears the 'printers' field, the 'has' method for this field will now return falsevoid
clearShowInReporting()
Clears the 'showInReporting' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.Tag
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.protected GenericClient
getGenericClient()
String
getId()
Unique identifierList<Reference>
getItems()
Items associated with this tagJSONObject
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()
Tag nameList<Reference>
getPrinters()
Printers associated with this tagBoolean
getShowInReporting()
True if tag is a summary label in the reporting appboolean
hasId()
Checks whether the 'id' field has been set, however the value could be nullboolean
hasItems()
Checks whether the 'items' 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
hasPrinters()
Checks whether the 'printers' field has been set, however the value could be nullboolean
hasShowInReporting()
Checks whether the 'showInReporting' field has been set, however the value could be nullboolean
isNotEmptyItems()
Checks whether the 'items' field is set and is not null and is not emptyboolean
isNotEmptyPrinters()
Checks whether the 'printers' field is set and is not null and is not emptyboolean
isNotNullId()
Checks whether the 'id' field is set and is not nullboolean
isNotNullItems()
Checks whether the 'items' field is set and is not nullboolean
isNotNullName()
Checks whether the 'name' field is set and is not nullboolean
isNotNullPrinters()
Checks whether the 'printers' field is set and is not nullboolean
isNotNullShowInReporting()
Checks whether the 'showInReporting' field is set and is not nullvoid
mergeChanges(Tag 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.Tag
setId(String id)
Sets the field 'id'.Tag
setItems(List<Reference> items)
Sets the field 'items'.Tag
setName(String name)
Sets the field 'name'.Tag
setPrinters(List<Reference> printers)
Sets the field 'printers'.Tag
setShowInReporting(Boolean showInReporting)
Sets the field 'showInReporting'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<Tag> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<Tag> JSON_CREATOR
-
-
Constructor Detail
-
Tag
public Tag()
Constructs a new empty instance.
-
Tag
protected Tag(boolean noInit)
Constructs a new empty instance.
-
Tag
public Tag(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
Tag
public Tag(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.
-
Tag
public Tag(Tag 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()
Tag name
-
getShowInReporting
public Boolean getShowInReporting()
True if tag is a summary label in the reporting app
-
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
-
isNotNullShowInReporting
public boolean isNotNullShowInReporting()
Checks whether the 'showInReporting' field is set and is not null
-
isNotNullItems
public boolean isNotNullItems()
Checks whether the 'items' field is set and is not null
-
isNotEmptyItems
public boolean isNotEmptyItems()
Checks whether the 'items' field is set and is not null and is not empty
-
isNotNullPrinters
public boolean isNotNullPrinters()
Checks whether the 'printers' field is set and is not null
-
isNotEmptyPrinters
public boolean isNotEmptyPrinters()
Checks whether the 'printers' field is set and is not null and is not empty
-
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
-
hasShowInReporting
public boolean hasShowInReporting()
Checks whether the 'showInReporting' field has been set, however the value could be null
-
hasItems
public boolean hasItems()
Checks whether the 'items' field has been set, however the value could be null
-
hasPrinters
public boolean hasPrinters()
Checks whether the 'printers' field has been set, however the value could be null
-
setShowInReporting
public Tag setShowInReporting(Boolean showInReporting)
Sets the field 'showInReporting'.
-
setItems
public Tag setItems(List<Reference> items)
Sets the field 'items'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
setPrinters
public Tag setPrinters(List<Reference> printers)
Sets the field 'printers'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
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
-
clearShowInReporting
public void clearShowInReporting()
Clears the 'showInReporting' field, the 'has' method for this field will now return false
-
clearItems
public void clearItems()
Clears the 'items' field, the 'has' method for this field will now return false
-
clearPrinters
public void clearPrinters()
Clears the 'printers' 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 Tag copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(Tag src)
Copy all the changed fields from the given source to this instance.
-
-