Package com.appiancorp.suiteapi.process

Class ProcessApplicationRoleMap

java.lang.Object

com.appiancorp.suiteapi.common.RoleMap

com.appiancorp.suiteapi.process.ProcessApplicationRoleMap

All Implemented Interfaces:

XMLable, Serializable, Map

public class ProcessApplicationRoleMap
extends RoleMap

Defines the roles of users and groups for a process object. The prossible roles are Editor, Viewer.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EDITOR
static final String	VIEWER

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

Constructors

Constructor	Description
ProcessApplicationRoleMap()

Method Summary

Modifier and Type	Method	Description
void	addEditorGroups(Long[] grids_)	Appends to the groups who have editor permissions
void	addEditors(String[] unames_)	Appends to the users who have editor permissions
void	addViewerGroups(Long[] grids_)	Appends to the groups who have viewer permissions
void	addViewers(String[] unames_)	Appends to the users who have viewer permissions
Long[]	getEditorGroups()	Retrieves the groups who have editor permissions
String[]	getEditors()	Retrieves the users who have editor permissions
Long[]	getViewerGroups()	Retrieves the groups who have viewer permissions
String[]	getViewers()	Retrieves the users who have viewer permissions
void	removeEditorGroups(Long[] grids_)	Deletes from the groups who have editor permissions
void	removeEditors(String[] unames_)	Deletes from the users who have editor permissions
void	removeViewerGroups(Long[] grids_)	Deletes from the groups who have viewer permissions
void	removeViewers(String[] unames_)	Deletes from the users who have viewer permissions
void	setEditorGroups(Long[] grids_)	Sets the groups who have editor permissions
void	setEditors(String[] unames_)	Sets the users who have editor permissions
void	setViewerGroups(Long[] grids_)	Sets the groups who have viewer permissions
void	setViewers(String[] unames_)	Sets the users who have viewer permissions

Methods 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

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

toXML

Field Details

EDITOR

public static final String EDITOR

See Also:

• Constant Field Values

VIEWER

public static final String VIEWER

See Also:

• Constant Field Values

Constructor Details

ProcessApplicationRoleMap

public ProcessApplicationRoleMap()

Method Details

getEditors

public String[] getEditors()

Retrieves the users who have editor permissions

Returns:

an Array containing the unique IDs (usernames) of the users

getEditorGroups

public Long[] getEditorGroups()

Retrieves the groups who have editor permissions

Returns:

Array containing the unique IDs of the groups

setEditors

public void setEditors(String[] unames_)

Sets the users who have editor permissions

Parameters:

unames_ - Array containing the unique IDs (usernames) of the users

setEditorGroups

public void setEditorGroups(Long[] grids_)

Sets the groups who have editor permissions

Parameters:

grids_ - Array containing the unique IDs of the groups

addEditors

public void addEditors(String[] unames_)

Appends to the users who have editor permissions

Parameters:

unames_ - Array containing the unique IDs (usernames) of the users to be added

addEditorGroups

public void addEditorGroups(Long[] grids_)

Appends to the groups who have editor permissions

Parameters:

grids_ - Array containing the unique IDs of the groups to be added

removeEditors

public void removeEditors(String[] unames_)

Deletes from the users who have editor permissions

Parameters:

unames_ - Array containing the unique IDs (usernames) of the users to be deleted

removeEditorGroups

public void removeEditorGroups(Long[] grids_)

Deletes from the groups who have editor permissions

Parameters:

grids_ - Array containing the unique IDs of the groups to be deleted

getViewers

public String[] getViewers()

Retrieves the users who have viewer permissions

Returns:

Array containing the unique IDs (usernames) of the users

getViewerGroups

public Long[] getViewerGroups()

Retrieves the groups who have viewer permissions

Returns:

Array containing the unique IDs of the groups

setViewers

public void setViewers(String[] unames_)

Sets the users who have viewer permissions

Parameters:

unames_ - Array containing the unique IDs (usernames) of the users

setViewerGroups

public void setViewerGroups(Long[] grids_)

Sets the groups who have viewer permissions

Parameters:

grids_ - Array containing the unique IDs of the groups

addViewers

public void addViewers(String[] unames_)

Appends to the users who have viewer permissions

Parameters:

unames_ - Array containing the unique IDs (usernames) of the users to be added

addViewerGroups

public void addViewerGroups(Long[] grids_)

Appends to the groups who have viewer permissions

Parameters:

grids_ - Array containing the unique IDs of the groups to be added

removeViewers

public void removeViewers(String[] unames_)

Deletes from the users who have viewer permissions

Parameters:

unames_ - Array containing the unique IDs (usernames) of the users to be deleted

removeViewerGroups

public void removeViewerGroups(Long[] grids_)

Deletes from the groups who have viewer permissions

Parameters:

grids_ - Array containing the unique IDs of the groups to be deleted