Package com.appiancorp.suiteapi.common

Class PublicRoleMap

java.lang.Object

com.appiancorp.suiteapi.common.RoleMap

com.appiancorp.suiteapi.common.PublicRoleMap

All Implemented Interfaces:

XMLable, Serializable, Map

Direct Known Subclasses:

AEVRoleMap, ForumsRoleMap

public class PublicRoleMap
extends RoleMap

Defines the roles of users and groups for an object.

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	ADMINISTRATOR
protected final String	TYPE_GROUP
protected final String	TYPE_USER

Fields inherited from class com.appiancorp.suiteapi.common.RoleMap

AGGREGATE_SECURITY_KEY, SECURITY_KEY, TYPE_AGGREGATE_GROUP, TYPE_AGGREGATE_USER, TYPE_GROUP_UUIDS, TYPE_USER_UUIDS

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

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
PublicRoleMap()

Method Summary

Modifier and Type	Method	Description
void	addAdministratorGroups(Long[] grids_)	Appends to the groups who have administrative permissions.
void	addAdministrators(String[] unames_)	Appends to the users who have administrative permissions.
Long[]	getAdministratorGroups()	Retrieves the groups who have administrative permissions.
String[]	getAdministrators()	Retrieves the users who have administrative permissions.
void	removeAdministratorGroups(Long[] grids_)	Deletes from the groups who have administrative permissions.
void	removeAdministrators(String[] unames_)	Deletes from the users who have administrative permissions.
void	setAdministratorGroups(Long[] grids_)	Sets the groups who have administrative permissions.
void	setAdministrators(String[] unames_)	Sets the users who have administrative 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

ADMINISTRATOR

public static final String ADMINISTRATOR

See Also:

• Constant Field Values

TYPE_USER

protected final String TYPE_USER

See Also:

• Constant Field Values

TYPE_GROUP

protected final String TYPE_GROUP

See Also:

• Constant Field Values

Constructor Details

PublicRoleMap

public PublicRoleMap()

Method Details

getAdministrators

public String[] getAdministrators()

Retrieves the users who have administrative permissions.

Returns:

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

See Also:

• setAdministrators(String[])

getAdministratorGroups

public Long[] getAdministratorGroups()

Retrieves the groups who have administrative permissions.

Returns:

an Array containing the unique IDs of the groups.

See Also:

• setAdministratorGroups(Long[])

setAdministrators

public void setAdministrators(String[] unames_)

Sets the users who have administrative permissions.

Parameters:

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

See Also:

• getAdministrators()

setAdministratorGroups

public void setAdministratorGroups(Long[] grids_)

Sets the groups who have administrative permissions.

Parameters:

grids_ - an Array containing the unique IDs of the groups

See Also:

• getAdministratorGroups()

addAdministrators

public void addAdministrators(String[] unames_)

Appends to the users who have administrative permissions.

Parameters:

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

addAdministratorGroups

public void addAdministratorGroups(Long[] grids_)

Appends to the groups who have administrative permissions.

Parameters:

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

removeAdministrators

public void removeAdministrators(String[] unames_)

Deletes from the users who have administrative permissions.

Parameters:

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

removeAdministratorGroups

public void removeAdministratorGroups(Long[] grids_)

Deletes from the groups who have administrative permissions.

Parameters:

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