Package com.clover.sdk.v3.employees
Class Role
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.employees.Role
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class Role extends GenericParcelable implements Validator, JSONifiable
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Role.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 String
AUTHORITY
static Parcelable.Creator<Role>
CREATOR
static JSONifiable.Creator<Role>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description Role()
Constructs a new empty instance.protected
Role(boolean noInit)
Constructs a new empty instance.Role(Role src)
Constructs a new instance that is a deep copy of the source instance.Role(String json)
Constructs a new instance from the given JSON String.Role(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
clearEmployeesRef()
Clears the 'employeesRef' 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
clearMerchant()
Clears the 'merchant' 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
clearSystemRole()
Clears the 'systemRole' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.Role
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.List<Reference>
getEmployeesRef()
employees with this roleprotected GenericClient
getGenericClient()
String
getId()
Unique identifierJSONObject
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.Reference
getMerchant()
The merchant this role belongs to.String
getName()
Full name of the roleAccountRole
getSystemRole()
Base System Roleboolean
hasEmployeesRef()
Checks whether the 'employeesRef' 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
hasMerchant()
Checks whether the 'merchant' 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
hasSystemRole()
Checks whether the 'systemRole' field has been set, however the value could be nullboolean
isNotEmptyEmployeesRef()
Checks whether the 'employeesRef' field is set and is not null and is not emptyboolean
isNotNullEmployeesRef()
Checks whether the 'employeesRef' field is set and is not nullboolean
isNotNullId()
Checks whether the 'id' field is set and is not nullboolean
isNotNullMerchant()
Checks whether the 'merchant' field is set and is not nullboolean
isNotNullName()
Checks whether the 'name' field is set and is not nullboolean
isNotNullSystemRole()
Checks whether the 'systemRole' field is set and is not nullvoid
mergeChanges(Role 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.Role
setEmployeesRef(List<Reference> employeesRef)
Sets the field 'employeesRef'.Role
setId(String id)
Sets the field 'id'.Role
setMerchant(Reference merchant)
Sets the field 'merchant'.Role
setName(String name)
Sets the field 'name'.Role
setSystemRole(AccountRole systemRole)
Sets the field 'systemRole'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
AUTHORITY
public static final String AUTHORITY
- See Also:
- Constant Field Values
-
CREATOR
public static final Parcelable.Creator<Role> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<Role> JSON_CREATOR
-
-
Constructor Detail
-
Role
public Role()
Constructs a new empty instance.
-
Role
protected Role(boolean noInit)
Constructs a new empty instance.
-
Role
public Role(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
Role
public Role(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.
-
Role
public Role(Role 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()
Full name of the role
-
getSystemRole
public AccountRole getSystemRole()
Base System Role
-
getMerchant
public Reference getMerchant()
The merchant this role belongs to.
-
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
-
isNotNullSystemRole
public boolean isNotNullSystemRole()
Checks whether the 'systemRole' field is set and is not null
-
isNotNullEmployeesRef
public boolean isNotNullEmployeesRef()
Checks whether the 'employeesRef' field is set and is not null
-
isNotEmptyEmployeesRef
public boolean isNotEmptyEmployeesRef()
Checks whether the 'employeesRef' field is set and is not null and is not empty
-
isNotNullMerchant
public boolean isNotNullMerchant()
Checks whether the 'merchant' 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
-
hasSystemRole
public boolean hasSystemRole()
Checks whether the 'systemRole' field has been set, however the value could be null
-
hasEmployeesRef
public boolean hasEmployeesRef()
Checks whether the 'employeesRef' 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
-
setSystemRole
public Role setSystemRole(AccountRole systemRole)
Sets the field 'systemRole'.
-
setEmployeesRef
public Role setEmployeesRef(List<Reference> employeesRef)
Sets the field 'employeesRef'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
setMerchant
public Role 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.
-
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
-
clearSystemRole
public void clearSystemRole()
Clears the 'systemRole' field, the 'has' method for this field will now return false
-
clearEmployeesRef
public void clearEmployeesRef()
Clears the 'employeesRef' 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
-
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 Role copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(Role src)
Copy all the changed fields from the given source to this instance.
-
-