Package com.appiancorp.suiteapi.process
Class ProcessRoleMap
java.lang.Object
com.appiancorp.suiteapi.common.RoleMap
com.appiancorp.suiteapi.process.ProcessRoleMap
- All Implemented Interfaces:
XMLable
,Serializable
,Map
Defines the roles of users and groups for a process object. The possible
roles are Administrator, Editor, Viewer, Manager, Initiator, Non Member.
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String[]
static final int
static final int
static final int
static final int
static final int
static final int
static final String
static final String
static final String
static final String
static final String
Fields inherited from class com.appiancorp.suiteapi.common.RoleMap
AGGREGATE_SECURITY_KEY, SECURITY_KEY, TYPE_AGGREGATE_GROUP, TYPE_AGGREGATE_USER, TYPE_GROUP, TYPE_GROUP_UUIDS, TYPE_USER, TYPE_USER_UUIDS
Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAdminOwnerGroups
(Long[] grids_) Adds administrative permission for the groupsvoid
addAdminOwners
(String[] unames_) Adds administrative permission for the usersvoid
addAnalystGroups
(Long[] grids_) Deprecated.void
addAnalysts
(String[] unames_) Deprecated.void
addEditorGroups
(Long[] grids_) Adds editor permission to the groupsvoid
addEditors
(String[] unames_) Adds editor permission to the usersvoid
addExplicitNonViewerGroups
(Long[] grids_) Adds explicitly denied permission to the groupsvoid
addExplicitNonViewers
(String[] unames_) Adds explicitly denied permission to the usersvoid
addInitiatorGroups
(Long[] grids_) Adds analyst permission to the groupsvoid
addInitiators
(String[] unames_) Adds analyst permission to the usersvoid
addManagerGroups
(Long[] grids_) Adds power user permissions to the groupsvoid
addManagers
(String[] unames_) Adds power user permissions to the usersvoid
addPowerUserGroups
(Long[] grids_) Deprecated.void
addPowerUsers
(String[] unames_) Deprecated.void
addViewerGroups
(Long[] grids_) Adds viewer permission to the groupsvoid
addViewers
(String[] unames_) Adds viewer permission to the usersLong[]
Retrieves the groups who have administrative permissionsString[]
Retrieves the users who have administrative permissionsLong[]
Deprecated.String[]
Deprecated.Long[]
Retrieves the groups who have editor permissionsString[]
Retrieves the users who have editor permissionsLong[]
Retrieves the groups who have been explicitly denied permissionsString[]
Retrieves the users who have been explicitly denied permissionsLong[]
Retrieves the groups who have analyst permissionsString[]
Retrieves the users who have analyst permissionsLong[]
Retrieves the groups who have power user permissionsString[]
Retrieves the users who have power user permissionsLong[]
Deprecated.String[]
Deprecated.static String
getRoleForColumn
(int n) Returns the role type (string) for a role integer idLong[]
Retrieves the groups who have viewer permissionsString[]
Retrieves the users who have viewer permissionsvoid
removeAdminOwnerGroups
(Long[] grids_) Removes the administrative permission of the groupsvoid
removeAdminOwners
(String[] unames_) Removes the administrative permission of the usersvoid
removeAnalystGroups
(Long[] grids_) Deprecated.void
removeAnalysts
(String[] unames_) Deprecated.void
removeEditorGroups
(Long[] grids_) Removes editor permission of the groupsvoid
removeEditors
(String[] unames_) Removes editor permission of the usersvoid
removeExplicitNonViewerGroups
(Long[] grids_) Deletes explicitly denied permissions from the groupsvoid
removeExplicitNonViewers
(String[] unames_) Deletes explicitly denied permissions from the usersvoid
removeInitiatorGroups
(Long[] grids_) Deletes analyst permissions from the groupsvoid
removeInitiators
(String[] unames_) Deletes analyst permissions from the usersvoid
removeManagerGroups
(Long[] grids_) Deletes power user permissions from the groupsvoid
removeManagers
(String[] unames_) Deletes power user permissions from the usersvoid
removePowerUserGroups
(Long[] grids_) Deprecated.void
removePowerUsers
(String[] unames_) Deprecated.void
removeViewerGroups
(Long[] grids_) Deletes the viewer permission of the groupsvoid
removeViewers
(String[] unames_) Deletes the viewer permission of the usersvoid
setAdminOwnerGroups
(Long[] grids_) Sets the groups who have administrative permissionsvoid
setAdminOwners
(String[] unames_) Sets the users who have administrative permissionsvoid
setAnalystGroups
(Long[] grids_) Deprecated.void
setAnalysts
(String[] unames_) Deprecated.void
setEditorGroups
(Long[] grids_) Sets the groups who have editor permissionsvoid
setEditors
(String[] unames_) Sets the users who have editor permissionsvoid
setExplicitNonViewerGroups
(Long[] grids_) Sets the groups who have been explicitly denied permissionsvoid
setExplicitNonViewers
(String[] unames_) Sets the users who have been explicitly denied permissionsvoid
setInitiatorGroups
(Long[] grids_) Sets the groups who have analyst permissionsvoid
setInitiators
(String[] unames_) Sets the users who have analyst permissionsvoid
setManagerGroups
(Long[] grids_) Sets the groups who have power user permissionsvoid
setManagers
(String[] unames_) Sets the users who have power user permissionsvoid
setPowerUserGroups
(Long[] grids_) Deprecated.void
setPowerUsers
(String[] unames_) Deprecated.void
setViewerGroups
(Long[] grids_) Sets the groups who have viewer permissionsvoid
setViewers
(String[] unames_) Sets the users who have viewer permissionsMethods inherited from class com.appiancorp.suiteapi.common.RoleMap
addActorsToRole, addActorsToRole, clear, containsActors, containsKey, containsValue, entrySet, equals, get, getActorsInRole, getAggregateSecurity, getAllGroupIds, getAllUsernames, getRole, getRoleNames, getRoles, getSecurity, hashCode, init, isEmpty, keySet, mergeWith, put, putAll, remove, removeActorsFromRole, removeActorsFromRole, removeAllRoles, setActorsInRole, setActorsInRole, setAggregateSecurity, setRole, setRoles, setRoles, setSecurity, size, toString, toXML, toXML, values
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Field Details
-
ADMIN_OWNER
- See Also:
-
EDITOR
- See Also:
-
VIEWER
- See Also:
-
INITIATOR
- See Also:
-
MANAGER
- See Also:
-
EXPLICIT_NONMEMBER
- See Also:
-
ALL_ROLES
-
COLUMN_ADMIN_OWNER
public static final int COLUMN_ADMIN_OWNER- See Also:
-
COLUMN_EDITOR
public static final int COLUMN_EDITOR- See Also:
-
COLUMN_MANAGER
public static final int COLUMN_MANAGER- See Also:
-
COLUMN_VIEWER
public static final int COLUMN_VIEWER- See Also:
-
COLUMN_INITIATOR
public static final int COLUMN_INITIATOR- See Also:
-
COLUMN_EXPLICIT_NONMEMBER
public static final int COLUMN_EXPLICIT_NONMEMBER- See Also:
-
-
Constructor Details
-
ProcessRoleMap
public ProcessRoleMap() -
ProcessRoleMap
-
-
Method Details
-
getRoleForColumn
Returns the role type (string) for a role integer id- Parameters:
n
- integer id of the role- Returns:
- role type
-
getAdminOwners
Retrieves the users who have administrative permissions- Returns:
- a list containing the unique IDs of the users
-
getAdminOwnerGroups
Retrieves the groups who have administrative permissions- Returns:
- a list containing the unique IDs of the groups
-
setAdminOwners
Sets the users who have administrative permissions- Parameters:
unames_
- a list containing the unique IDs of the users
-
setAdminOwnerGroups
Sets the groups who have administrative permissions- Parameters:
grids_
- a list containing the unique IDs of the groups
-
addAdminOwners
Adds administrative permission for the users- Parameters:
unames_
- a list containing the unique IDs of the users to be added
-
addAdminOwnerGroups
Adds administrative permission for the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be added
-
removeAdminOwners
Removes the administrative permission of the users- Parameters:
unames_
- a list containing the unique IDs of the users to be deleted
-
removeAdminOwnerGroups
Removes the administrative permission of the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be deleted
-
getEditors
Retrieves the users who have editor permissions- Returns:
- a list containing the unique IDs of the users
-
getEditorGroups
Retrieves the groups who have editor permissions- Returns:
- a list containing the unique IDs of the groups
-
setEditors
Sets the users who have editor permissions- Parameters:
unames_
- a list containing the unique IDs of the users
-
setEditorGroups
Sets the groups who have editor permissions- Parameters:
grids_
- a list containing the unique IDs of the groups
-
addEditors
Adds editor permission to the users- Parameters:
unames_
- a list containing the unique IDs of the users to be added
-
addEditorGroups
Adds editor permission to the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be added
-
removeEditors
Removes editor permission of the users- Parameters:
unames_
- a list containing the unique IDs of the users to be deleted
-
removeEditorGroups
Removes editor permission of the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be deleted
-
getViewers
Retrieves the users who have viewer permissions- Returns:
- a list containing the unique IDs of the users
-
getViewerGroups
Retrieves the groups who have viewer permissions- Returns:
- a list containing the unique IDs of the groups
-
setViewers
Sets the users who have viewer permissions- Parameters:
unames_
- a list containing the unique IDs of the users
-
setViewerGroups
Sets the groups who have viewer permissions- Parameters:
grids_
- a list containing the unique IDs of the groups
-
addViewers
Adds viewer permission to the users- Parameters:
unames_
- a list containing the unique IDs of the users to be added
-
addViewerGroups
Adds viewer permission to the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be added
-
removeViewers
Deletes the viewer permission of the users- Parameters:
unames_
- a list containing the unique IDs of the users to be deleted
-
removeViewerGroups
Deletes the viewer permission of the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be deleted
-
getAnalysts
Deprecated. -
getInitiators
Retrieves the users who have analyst permissions- Returns:
- a list containing the unique IDs of the users
-
getAnalystGroups
Deprecated. -
getInitiatorGroups
Retrieves the groups who have analyst permissions- Returns:
- a list containing the unique IDs of the groups
-
setAnalysts
Deprecated. -
setInitiators
Sets the users who have analyst permissions- Parameters:
unames_
- a list containing the unique IDs of the users
-
setAnalystGroups
Deprecated. -
setInitiatorGroups
Sets the groups who have analyst permissions- Parameters:
grids_
- a list containing the unique IDs of the groups
-
addAnalysts
Deprecated. -
addInitiators
Adds analyst permission to the users- Parameters:
unames_
- a list containing the unique IDs of the users to be added
-
addAnalystGroups
Deprecated. -
addInitiatorGroups
Adds analyst permission to the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be added
-
removeAnalysts
Deprecated. -
removeInitiators
Deletes analyst permissions from the users- Parameters:
unames_
- a list containing the unique IDs of the users to be deleted
-
removeAnalystGroups
Deprecated. -
removeInitiatorGroups
Deletes analyst permissions from the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be deleted
-
getPowerUsers
Deprecated. -
getManagers
Retrieves the users who have power user permissions- Returns:
- a list containing the unique IDs of the users
-
getPowerUserGroups
Deprecated. -
getManagerGroups
Retrieves the groups who have power user permissions- Returns:
- a list containing the unique IDs of the groups
-
setPowerUsers
Deprecated. -
setManagers
Sets the users who have power user permissions- Parameters:
unames_
- a list containing the unique IDs of the users
-
setPowerUserGroups
Deprecated. -
setManagerGroups
Sets the groups who have power user permissions- Parameters:
grids_
- a list containing the unique IDs of the groups
-
addPowerUsers
Deprecated. -
addManagers
Adds power user permissions to the users- Parameters:
unames_
- a list containing the unique IDs of the users to be added
-
addPowerUserGroups
Deprecated. -
addManagerGroups
Adds power user permissions to the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be added
-
removePowerUsers
Deprecated. -
removeManagers
Deletes power user permissions from the users- Parameters:
unames_
- a list containing the unique IDs of the users to be deleted
-
removePowerUserGroups
Deprecated. -
removeManagerGroups
Deletes power user permissions from the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be deleted
-
getExplicitNonViewers
Retrieves the users who have been explicitly denied permissions- Returns:
- a list containing the unique IDs of the users
-
getExplicitNonViewerGroups
Retrieves the groups who have been explicitly denied permissions- Returns:
- a list containing the unique IDs of the groups
-
setExplicitNonViewers
Sets the users who have been explicitly denied permissions- Parameters:
unames_
- a list containing the unique IDs of the users
-
setExplicitNonViewerGroups
Sets the groups who have been explicitly denied permissions- Parameters:
grids_
- a list containing the unique IDs of the groups
-
addExplicitNonViewers
Adds explicitly denied permission to the users- Parameters:
unames_
- a list containing the unique IDs of the users to be added
-
addExplicitNonViewerGroups
Adds explicitly denied permission to the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be added
-
removeExplicitNonViewers
Deletes explicitly denied permissions from the users- Parameters:
unames_
- a list containing the unique IDs of the users to be deleted
-
removeExplicitNonViewerGroups
Deletes explicitly denied permissions from the groups- Parameters:
grids_
- a list containing the unique IDs of the groups to be deleted
-