Package com.appiancorp.suiteapi.common

Class AEVRoleMap

java.lang.Object

com.appiancorp.suiteapi.common.RoleMap

com.appiancorp.suiteapi.common.PublicRoleMap

com.appiancorp.suiteapi.common.AEVRoleMap

All Implemented Interfaces:

XMLable, Serializable, Map

Direct Known Subclasses:

PortalRoleMap

public class AEVRoleMap
extends PublicRoleMap

This class can be used as base class for any object acting as RoleMap where User and Group can be added to view or edit a particular object.

See Also:

• PortalRoleMap
• User
• Group
• 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.PublicRoleMap

ADMINISTRATOR, TYPE_GROUP, 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
AEVRoleMap()

Method Summary

Modifier and Type	Method	Description
void	addEditorGroups(Long[] id_)	Adds the Groups identified by given ID's as editors to existing array of Group Editors.
void	addEditors(String[] id_)	Adds the Users identified by given usernames as editors to existing array of Editors.
void	addViewerGroups(Long[] id_)	Adds the Groups identified by given ID's as viewers to existing array of Group Viewers.
void	addViewers(String[] id_)	Adds the Users identified by given usernames as viewers to existing array of Viewers.
Long[]	getEditorGroups()	Returns the ID's of Groups whose role is Editor of object.
String[]	getEditors()	Returns the usernames of Users whose role is Editor of object.
Long[]	getViewerGroups()	Returns the ID's of Groups whose role is Viewer of object.
String[]	getViewers()	Returns the usernames of Users whose role is Viewer of object.
void	removeEditorGroups(Long[] id_)	Removes the Groups identified by given ID's as editors.
void	removeEditors(String[] id_)	Removes the Users identified by given usernames as editors.
void	removeViewerGroups(Long[] id_)	Removes the Groups identified by given ID's as viewers.
void	removeViewers(String[] id_)	Removes the Users identified by given usernames as viewers.
void	setEditorGroups(Long[] id_)	Sets the Groups identified by given ID's as editors.
void	setEditors(String[] id_)	Sets the Users identified by given usernames as editors.
void	setViewerGroups(Long[] id_)	Sets the Groups identified by given ID's as viewers.
void	setViewers(String[] id_)	Sets the Users identified by given usernames as viewers.

Methods inherited from class com.appiancorp.suiteapi.common.PublicRoleMap

addAdministratorGroups, addAdministrators, getAdministratorGroups, getAdministrators, removeAdministratorGroups, removeAdministrators, setAdministratorGroups, setAdministrators

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

AEVRoleMap

public AEVRoleMap()

Method Details

getEditors

public String[] getEditors()

Returns the usernames of Users whose role is Editor of object.

Returns:

string array of usernames

See Also:

• setEditors(String[])

getEditorGroups

public Long[] getEditorGroups()

Returns the ID's of Groups whose role is Editor of object.

Returns:

Long array of group ID's

See Also:

• setEditorGroups(Long[])

getViewers

public String[] getViewers()

Returns the usernames of Users whose role is Viewer of object.

Returns:

string array of usernames

See Also:

• setViewers(String[])

getViewerGroups

public Long[] getViewerGroups()

Returns the ID's of Groups whose role is Viewer of object.

Returns:

Long array of group ID's

See Also:

• setViewerGroups(Long[])

setEditors

public void setEditors(String[] id_)

Sets the Users identified by given usernames as editors.

Parameters:

id_ - array of usernames to set as editors

See Also:

• getEditors()

setEditorGroups

public void setEditorGroups(Long[] id_)

Sets the Groups identified by given ID's as editors.

Parameters:

id_ - array of Group ID's to set as editors

See Also:

• getEditorGroups()

setViewers

public void setViewers(String[] id_)

Sets the Users identified by given usernames as viewers.

Parameters:

id_ - array of usernames to set as viewers

See Also:

• getViewers()

setViewerGroups

public void setViewerGroups(Long[] id_)

Sets the Groups identified by given ID's as viewers.

Parameters:

id_ - array of Group ID's to set as viewers

See Also:

• getViewerGroups()

addEditors

public void addEditors(String[] id_)

Adds the Users identified by given usernames as editors to existing array of Editors.

Parameters:

id_ - array of usernames to add as editors

addEditorGroups

public void addEditorGroups(Long[] id_)

Adds the Groups identified by given ID's as editors to existing array of Group Editors.

Parameters:

id_ - array of ID's to add as editors

addViewers

public void addViewers(String[] id_)

Adds the Users identified by given usernames as viewers to existing array of Viewers.

Parameters:

id_ - array of usernames to add as viewers

addViewerGroups

public void addViewerGroups(Long[] id_)

Adds the Groups identified by given ID's as viewers to existing array of Group Viewers.

Parameters:

id_ - array of ID's to add as viewers

removeEditors

public void removeEditors(String[] id_)

Removes the Users identified by given usernames as editors.

Parameters:

id_ - array of usernames to remove as editors

removeEditorGroups

public void removeEditorGroups(Long[] id_)

Removes the Groups identified by given ID's as editors.

Parameters:

id_ - array of ID's to remove as editors

removeViewers

public void removeViewers(String[] id_)

Removes the Users identified by given usernames as viewers.

Parameters:

id_ - array of usernames to remove as viewers

removeViewerGroups

public void removeViewerGroups(Long[] id_)

Removes the Groups identified by given ID's as viewers.

Parameters:

id_ - array of ID's to remove as viewers