Package com.clover.sdk.v3.inventory
Class Category
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.inventory.Category
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class Category extends GenericParcelable implements Validator, JSONifiable
This is an auto-generated Clover data object.Fields
- See Also:
IInventoryService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Category.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<Category>
CREATOR
static JSONifiable.Creator<Category>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description Category()
Constructs a new empty instance.protected
Category(boolean noInit)
Constructs a new empty instance.Category(Category src)
Constructs a new instance that is a deep copy of the source instance.Category(String json)
Constructs a new instance from the given JSON String.Category(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
clearCanonical()
Clears the 'canonical' field, the 'has' method for this field will now return falsevoid
clearColorCode()
Clears the 'colorCode' field, the 'has' method for this field will now return falsevoid
clearDeleted()
Clears the 'deleted' 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
clearItems()
Clears the 'items' field, the 'has' method for this field will now return falsevoid
clearMenuSection()
Clears the 'menuSection' field, the 'has' method for this field will now return falsevoid
clearModifiedTime()
Clears the 'modifiedTime' 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
clearSortOrder()
Clears the 'sortOrder' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.Category
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.Reference
getCanonical()
Reference to canonical categoryString
getColorCode()
Hex code representation of the color assigned to this category and its items, in the form of #fff, #ffffff, or #ffffffffBoolean
getDeleted()
Whether the category has been deleted.protected GenericClient
getGenericClient()
String
getId()
Unique identifierList<Reference>
getItems()
Ordered list of items associated with this category.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.MenuSection
getMenuSection()
Menu Section attribute that can be expanded to menu section specific attributesLong
getModifiedTime()
The time this category was last modifiedString
getName()
The name of the category which will appear in Clover Register App.Integer
getSortOrder()
Integer used to determine how this category is sorted against other categories.boolean
hasCanonical()
Checks whether the 'canonical' field has been set, however the value could be nullboolean
hasColorCode()
Checks whether the 'colorCode' field has been set, however the value could be nullboolean
hasDeleted()
Checks whether the 'deleted' 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
hasItems()
Checks whether the 'items' field has been set, however the value could be nullboolean
hasMenuSection()
Checks whether the 'menuSection' field has been set, however the value could be nullboolean
hasModifiedTime()
Checks whether the 'modifiedTime' 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
hasSortOrder()
Checks whether the 'sortOrder' 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
isNotNullCanonical()
Checks whether the 'canonical' field is set and is not nullboolean
isNotNullColorCode()
Checks whether the 'colorCode' field is set and is not nullboolean
isNotNullDeleted()
Checks whether the 'deleted' field is set and is not nullboolean
isNotNullId()
Checks whether the 'id' field is set and is not nullboolean
isNotNullItems()
Checks whether the 'items' field is set and is not nullboolean
isNotNullMenuSection()
Checks whether the 'menuSection' field is set and is not nullboolean
isNotNullModifiedTime()
Checks whether the 'modifiedTime' field is set and is not nullboolean
isNotNullName()
Checks whether the 'name' field is set and is not nullboolean
isNotNullSortOrder()
Checks whether the 'sortOrder' field is set and is not nullvoid
mergeChanges(Category 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.Category
setCanonical(Reference canonical)
Sets the field 'canonical'.Category
setColorCode(String colorCode)
Sets the field 'colorCode'.Category
setDeleted(Boolean deleted)
Sets the field 'deleted'.Category
setId(String id)
Sets the field 'id'.Category
setItems(List<Reference> items)
Sets the field 'items'.Category
setMenuSection(MenuSection menuSection)
Sets the field 'menuSection'.Category
setModifiedTime(Long modifiedTime)
Sets the field 'modifiedTime'.Category
setName(String name)
Sets the field 'name'.Category
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<Category> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<Category> JSON_CREATOR
-
-
Constructor Detail
-
Category
public Category()
Constructs a new empty instance.
-
Category
protected Category(boolean noInit)
Constructs a new empty instance.
-
Category
public Category(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
Category
public Category(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.
-
Category
public Category(Category 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 name of the category which will appear in Clover Register App.
-
getSortOrder
public Integer getSortOrder()
Integer used to determine how this category is sorted against other categories.
-
getColorCode
public String getColorCode()
Hex code representation of the color assigned to this category and its items, in the form of #fff, #ffffff, or #ffffffff
-
getDeleted
public Boolean getDeleted()
Whether the category has been deleted.
-
getModifiedTime
public Long getModifiedTime()
The time this category was last modified
-
getCanonical
public Reference getCanonical()
Reference to canonical category
-
getMenuSection
public MenuSection getMenuSection()
Menu Section attribute that can be expanded to menu section specific attributes
-
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
-
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
-
isNotNullColorCode
public boolean isNotNullColorCode()
Checks whether the 'colorCode' field is set and is not null
-
isNotNullDeleted
public boolean isNotNullDeleted()
Checks whether the 'deleted' field is set and is not null
-
isNotNullModifiedTime
public boolean isNotNullModifiedTime()
Checks whether the 'modifiedTime' field is set and is not null
-
isNotNullCanonical
public boolean isNotNullCanonical()
Checks whether the 'canonical' field is set and is not null
-
isNotNullMenuSection
public boolean isNotNullMenuSection()
Checks whether the 'menuSection' 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
-
hasItems
public boolean hasItems()
Checks whether the 'items' field has been set, however the value could be null
-
hasColorCode
public boolean hasColorCode()
Checks whether the 'colorCode' field has been set, however the value could be null
-
hasDeleted
public boolean hasDeleted()
Checks whether the 'deleted' field has been set, however the value could be null
-
hasModifiedTime
public boolean hasModifiedTime()
Checks whether the 'modifiedTime' field has been set, however the value could be null
-
hasCanonical
public boolean hasCanonical()
Checks whether the 'canonical' field has been set, however the value could be null
-
hasMenuSection
public boolean hasMenuSection()
Checks whether the 'menuSection' field has been set, however the value could be null
-
setItems
public Category 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.
-
setCanonical
public Category setCanonical(Reference canonical)
Sets the field 'canonical'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setMenuSection
public Category setMenuSection(MenuSection menuSection)
Sets the field 'menuSection'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
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
-
clearItems
public void clearItems()
Clears the 'items' field, the 'has' method for this field will now return false
-
clearColorCode
public void clearColorCode()
Clears the 'colorCode' field, the 'has' method for this field will now return false
-
clearDeleted
public void clearDeleted()
Clears the 'deleted' field, the 'has' method for this field will now return false
-
clearModifiedTime
public void clearModifiedTime()
Clears the 'modifiedTime' field, the 'has' method for this field will now return false
-
clearCanonical
public void clearCanonical()
Clears the 'canonical' field, the 'has' method for this field will now return false
-
clearMenuSection
public void clearMenuSection()
Clears the 'menuSection' 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 Category copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(Category src)
Copy all the changed fields from the given source to this instance.
-
-