PermissionSet (clover-android-sdk 293 API)

java.lang.Object
- com.clover.sdk.GenericParcelable
- - com.clover.sdk.v3.employees.PermissionSet

All Implemented Interfaces:

Parcelable, JSONifiable, Validator
```
public class PermissionSet
extends GenericParcelable
implements Validator, JSONifiable
```
This is an auto-generated Clover data object.

Fields

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PermissionSet.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>, Parcelable.Creator<T>

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PermissionSet.Constraints`

Field Summary

Fields
Modifier and Type Field and Description

static String AUTHORITY

static Parcelable.Creator<PermissionSet> CREATOR

static JSONifiable.Creator<PermissionSet> JSON_CREATOR
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static String`	`AUTHORITY`
`static Parcelable.Creator<PermissionSet>`	`CREATOR`
`static JSONifiable.Creator<PermissionSet>`	`JSON_CREATOR`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PermissionSet()` Constructs a new empty instance.
`protected`	`PermissionSet(boolean noInit)` Constructs a new empty instance.
	`PermissionSet(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.
	`PermissionSet(PermissionSet src)` Constructs a new instance that is a deep copy of the source instance.
	`PermissionSet(String json)` Constructs a new instance from the given JSON String.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearApp()` Clears the 'app' field, the 'has' method for this field will now return false
`void`	`clearEmployeeDefault()` Clears the 'employeeDefault' field, the 'has' method for this field will now return false
`void`	`clearEmployeePermissions()` Clears the 'employeePermissions' field, the 'has' method for this field will now return false
`void`	`clearId()` Clears the 'id' field, the 'has' method for this field will now return false
`void`	`clearLabel()` Clears the 'label' field, the 'has' method for this field will now return false
`void`	`clearManagerDefault()` Clears the 'managerDefault' field, the 'has' method for this field will now return false
`void`	`clearModule()` Clears the 'module' field, the 'has' method for this field will now return false
`void`	`clearName()` Clears the 'name' field, the 'has' method for this field will now return false
`void`	`clearPermissions()` Clears the 'permissions' field, the 'has' method for this field will now return false
`void`	`clearRoles()` Clears the 'roles' field, the 'has' method for this field will now return false
`boolean`	`containsChanges()` Returns true if this instance has any changes.
`PermissionSet`	`copyChanges()` Create a copy of this instance that contains only fields that were set after the constructor was called.
`Reference`	`getApp()`
`Boolean`	`getEmployeeDefault()`
`List<EmployeePermission>`	`getEmployeePermissions()`
`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`	`getLabel()` Label of the permissionSet
`Boolean`	`getManagerDefault()`
`Reference`	`getModule()` The module associated with this permission set (if any)
`String`	`getName()` Key of the permissionSet
`Permissions`	`getPermissions()` Bitmap of permissions
`List<Reference>`	`getRoles()` roles enabled for this merchant
`boolean`	`hasApp()` Checks whether the 'app' field has been set, however the value could be null
`boolean`	`hasEmployeeDefault()` Checks whether the 'employeeDefault' field has been set, however the value could be null
`boolean`	`hasEmployeePermissions()` Checks whether the 'employeePermissions' field has been set, however the value could be null
`boolean`	`hasId()` Checks whether the 'id' field has been set, however the value could be null
`boolean`	`hasLabel()` Checks whether the 'label' field has been set, however the value could be null
`boolean`	`hasManagerDefault()` Checks whether the 'managerDefault' field has been set, however the value could be null
`boolean`	`hasModule()` Checks whether the 'module' field has been set, however the value could be null
`boolean`	`hasName()` Checks whether the 'name' field has been set, however the value could be null
`boolean`	`hasPermissions()` Checks whether the 'permissions' field has been set, however the value could be null
`boolean`	`hasRoles()` Checks whether the 'roles' field has been set, however the value could be null
`boolean`	`isNotEmptyEmployeePermissions()` Checks whether the 'employeePermissions' field is set and is not null and is not empty
`boolean`	`isNotEmptyRoles()` Checks whether the 'roles' field is set and is not null and is not empty
`boolean`	`isNotNullApp()` Checks whether the 'app' field is set and is not null
`boolean`	`isNotNullEmployeeDefault()` Checks whether the 'employeeDefault' field is set and is not null
`boolean`	`isNotNullEmployeePermissions()` Checks whether the 'employeePermissions' field is set and is not null
`boolean`	`isNotNullId()` Checks whether the 'id' field is set and is not null
`boolean`	`isNotNullLabel()` Checks whether the 'label' field is set and is not null
`boolean`	`isNotNullManagerDefault()` Checks whether the 'managerDefault' field is set and is not null
`boolean`	`isNotNullModule()` Checks whether the 'module' field is set and is not null
`boolean`	`isNotNullName()` Checks whether the 'name' field is set and is not null
`boolean`	`isNotNullPermissions()` Checks whether the 'permissions' field is set and is not null
`boolean`	`isNotNullRoles()` Checks whether the 'roles' field is set and is not null
`void`	`mergeChanges(PermissionSet 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.
`PermissionSet`	`setApp(Reference app)` Sets the field 'app'.
`PermissionSet`	`setEmployeeDefault(Boolean employeeDefault)` Sets the field 'employeeDefault'.
`PermissionSet`	`setEmployeePermissions(List<EmployeePermission> employeePermissions)` Sets the field 'employeePermissions'.
`PermissionSet`	`setId(String id)` Sets the field 'id'.
`PermissionSet`	`setLabel(String label)` Sets the field 'label'.
`PermissionSet`	`setManagerDefault(Boolean managerDefault)` Sets the field 'managerDefault'.
`PermissionSet`	`setModule(Reference module)` Sets the field 'module'.
`PermissionSet`	`setName(String name)` Sets the field 'name'.
`PermissionSet`	`setPermissions(Permissions permissions)` Sets the field 'permissions'.
`PermissionSet`	`setRoles(List<Reference> roles)` Sets the field 'roles'.
`void`	`validate()`

Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - AUTHORITY
```
public static final String AUTHORITY
```
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final Parcelable.Creator<PermissionSet> CREATOR
```
  - JSON_CREATOR
```
public static final JSONifiable.Creator<PermissionSet> JSON_CREATOR
```
- Constructor Detail
  - PermissionSet
```
public PermissionSet()
```
    Constructs a new empty instance.
  - PermissionSet
```
protected PermissionSet(boolean noInit)
```
    Constructs a new empty instance.
  - PermissionSet
```
public PermissionSet(String json)
              throws IllegalArgumentException
```
    Constructs a new instance from the given JSON String.
    
    Throws:
    
    IllegalArgumentException
  - PermissionSet
```
public PermissionSet(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.
  - PermissionSet
```
public PermissionSet(PermissionSet 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()
```
    Key of the permissionSet
  - getLabel
```
public String getLabel()
```
    Label of the permissionSet
  - getApp
```
public Reference getApp()
```
  - getEmployeeDefault
```
public Boolean getEmployeeDefault()
```
  - getManagerDefault
```
public Boolean getManagerDefault()
```
  - getPermissions
```
public Permissions getPermissions()
```
    Bitmap of permissions
  - getEmployeePermissions
```
public List<EmployeePermission> getEmployeePermissions()
```
  - getRoles
```
public List<Reference> getRoles()
```
    roles enabled for this merchant
  - getModule
```
public Reference getModule()
```
    The module associated with this permission set (if any)
  - getGenericClient
```
protected GenericClient getGenericClient()
```
    Specified by:
    
    getGenericClient in class GenericParcelable
  - 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 interface JSONifiable
  - validate
```
public void validate()
```
    Specified by:
    
    validate in interface Validator
  - 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
  - isNotNullLabel
```
public boolean isNotNullLabel()
```
    Checks whether the 'label' field is set and is not null
  - isNotNullApp
```
public boolean isNotNullApp()
```
    Checks whether the 'app' field is set and is not null
  - isNotNullEmployeeDefault
```
public boolean isNotNullEmployeeDefault()
```
    Checks whether the 'employeeDefault' field is set and is not null
  - isNotNullManagerDefault
```
public boolean isNotNullManagerDefault()
```
    Checks whether the 'managerDefault' field is set and is not null
  - isNotNullPermissions
```
public boolean isNotNullPermissions()
```
    Checks whether the 'permissions' field is set and is not null
  - isNotNullEmployeePermissions
```
public boolean isNotNullEmployeePermissions()
```
    Checks whether the 'employeePermissions' field is set and is not null
  - isNotEmptyEmployeePermissions
```
public boolean isNotEmptyEmployeePermissions()
```
    Checks whether the 'employeePermissions' field is set and is not null and is not empty
  - isNotNullRoles
```
public boolean isNotNullRoles()
```
    Checks whether the 'roles' field is set and is not null
  - isNotEmptyRoles
```
public boolean isNotEmptyRoles()
```
    Checks whether the 'roles' field is set and is not null and is not empty
  - isNotNullModule
```
public boolean isNotNullModule()
```
    Checks whether the 'module' 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
  - hasLabel
```
public boolean hasLabel()
```
    Checks whether the 'label' field has been set, however the value could be null
  - hasApp
```
public boolean hasApp()
```
    Checks whether the 'app' field has been set, however the value could be null
  - hasEmployeeDefault
```
public boolean hasEmployeeDefault()
```
    Checks whether the 'employeeDefault' field has been set, however the value could be null
  - hasManagerDefault
```
public boolean hasManagerDefault()
```
    Checks whether the 'managerDefault' field has been set, however the value could be null
  - hasPermissions
```
public boolean hasPermissions()
```
    Checks whether the 'permissions' field has been set, however the value could be null
  - hasEmployeePermissions
```
public boolean hasEmployeePermissions()
```
    Checks whether the 'employeePermissions' field has been set, however the value could be null
  - hasRoles
```
public boolean hasRoles()
```
    Checks whether the 'roles' field has been set, however the value could be null
  - hasModule
```
public boolean hasModule()
```
    Checks whether the 'module' field has been set, however the value could be null
  - setId
```
public PermissionSet setId(String id)
```
    Sets the field 'id'.
  - setName
```
public PermissionSet setName(String name)
```
    Sets the field 'name'.
  - setLabel
```
public PermissionSet setLabel(String label)
```
    Sets the field 'label'.
  - setApp
```
public PermissionSet setApp(Reference app)
```
    Sets the field 'app'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
  - setEmployeeDefault
```
public PermissionSet setEmployeeDefault(Boolean employeeDefault)
```
    Sets the field 'employeeDefault'.
  - setManagerDefault
```
public PermissionSet setManagerDefault(Boolean managerDefault)
```
    Sets the field 'managerDefault'.
  - setPermissions
```
public PermissionSet setPermissions(Permissions permissions)
```
    Sets the field 'permissions'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
  - setEmployeePermissions
```
public PermissionSet setEmployeePermissions(List<EmployeePermission> employeePermissions)
```
    Sets the field 'employeePermissions'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
  - setRoles
```
public PermissionSet setRoles(List<Reference> roles)
```
    Sets the field 'roles'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
  - setModule
```
public PermissionSet setModule(Reference module)
```
    Sets the field 'module'. 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
  - clearLabel
```
public void clearLabel()
```
    Clears the 'label' field, the 'has' method for this field will now return false
  - clearApp
```
public void clearApp()
```
    Clears the 'app' field, the 'has' method for this field will now return false
  - clearEmployeeDefault
```
public void clearEmployeeDefault()
```
    Clears the 'employeeDefault' field, the 'has' method for this field will now return false
  - clearManagerDefault
```
public void clearManagerDefault()
```
    Clears the 'managerDefault' field, the 'has' method for this field will now return false
  - clearPermissions
```
public void clearPermissions()
```
    Clears the 'permissions' field, the 'has' method for this field will now return false
  - clearEmployeePermissions
```
public void clearEmployeePermissions()
```
    Clears the 'employeePermissions' field, the 'has' method for this field will now return false
  - clearRoles
```
public void clearRoles()
```
    Clears the 'roles' field, the 'has' method for this field will now return false
  - clearModule
```
public void clearModule()
```
    Clears the 'module' 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 PermissionSet copyChanges()
```
    Create a copy of this instance that contains only fields that were set after the constructor was called.
  - mergeChanges
```
public void mergeChanges(PermissionSet src)
```
    Copy all the changed fields from the given source to this instance.

Class PermissionSet

Fields

Nested Class Summary

Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class com.clover.sdk.GenericParcelable

Methods inherited from class java.lang.Object

Field Detail

AUTHORITY

CREATOR

JSON_CREATOR

Constructor Detail

PermissionSet

PermissionSet

PermissionSet

PermissionSet

PermissionSet

Method Detail

getId

getName

getLabel

getApp

getEmployeeDefault

getManagerDefault

getPermissions

getEmployeePermissions

getRoles

getModule

getGenericClient

getJSONObject

validate

isNotNullId

isNotNullName

isNotNullLabel

isNotNullApp

isNotNullEmployeeDefault

isNotNullManagerDefault

isNotNullPermissions

isNotNullEmployeePermissions

isNotEmptyEmployeePermissions

isNotNullRoles

isNotEmptyRoles

isNotNullModule

hasId

hasName

hasLabel

hasApp

hasEmployeeDefault

hasManagerDefault

hasPermissions

hasEmployeePermissions

hasRoles

hasModule

setId

setName

setLabel

setApp

setEmployeeDefault

setManagerDefault

setPermissions

setEmployeePermissions

setRoles

setModule

clearId

clearName

clearLabel

clearApp

clearEmployeeDefault

clearManagerDefault

clearPermissions

clearEmployeePermissions

clearRoles

clearModule

containsChanges

resetChangeLog

copyChanges