com.appiancorp.suiteapi.administration

Class AdminConsoleRoleMap

java.lang.Object

com.appiancorp.suiteapi.common.RoleMap

com.appiancorp.suiteapi.administration.AdminConsoleRoleMap

All Implemented Interfaces:

XMLable, java.io.Serializable, java.util.Map

Deprecated.

This class pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.

@Deprecated
public class AdminConsoleRoleMap
extends RoleMap

The Role Map for the Administration Console. The possible roles are Viewer and Editor.

Viewers can enter the Administration Console, create pages, and view pages that they have permission to view. Editors can edit the security settings of the Administration Console.

See Also:

Serialized Form

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EDITOR Deprecated. The editor role.
static java.lang.String	VIEWER Deprecated. The viewer role.

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 and Description
AdminConsoleRoleMap() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addEditorGroups(java.lang.Long[] groups_) Deprecated. Adds to the list of groups that have editor permissions.
void	addEditors(java.lang.String[] users_) Deprecated. Adds to the list of users that have editor permissions.
void	addViewerGroups(java.lang.Long[] groups_) Deprecated. Adds to the list of groups that have viewer permissions.
void	addViewers(java.lang.String[] users_) Deprecated. Adds to the list of users that have viewer permissions.
java.lang.Long[]	getEditorGroups() Deprecated. Returns the list of groups that have editor permissions.
java.lang.String[]	getEditors() Deprecated. Returns the list of users that have editor permissions.
static java.lang.String	getRoleForColumn(int n_) Deprecated. Returns the role for the specified column number.
java.lang.Long[]	getViewerGroups() Deprecated. Returns the list of groups that have viewer permissions.
java.lang.String[]	getViewers() Deprecated. Returns the list of users that have viewer permissions.
void	removeEditorGroups(java.lang.Long[] groups_) Deprecated. Removes from the list of groups with editor permissions.
void	removeEditors(java.lang.String[] users_) Deprecated. Removes from the list of users that have editor permissions.
void	removeViewerGroups(java.lang.Long[] groups_) Deprecated. Removes from the list of groups with viewer permissions.
void	removeViewers(java.lang.String[] users_) Deprecated. Removes from the list of users that have viewer permissions.
void	setEditorGroups(java.lang.Long[] groups_) Deprecated. Sets the list of groups with editor permissions.
void	setEditors(java.lang.String[] users_) Deprecated. Sets the list of users that have editor permissions.
void	setViewerGroups(java.lang.Long[] groups_) Deprecated. Sets the list of groups with viewer permissions.
void	setViewers(java.lang.String[] users_) Deprecated. Sets the list of users that 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 Detail

VIEWER

public static final java.lang.String VIEWER

Deprecated.

The viewer role.

See Also:

Constant Field Values

EDITOR

public static final java.lang.String EDITOR

Deprecated.

The editor role.

See Also:

Constant Field Values

Constructor Detail

AdminConsoleRoleMap

public AdminConsoleRoleMap()

Deprecated.

Method Detail

getRoleForColumn

public static java.lang.String getRoleForColumn(int n_)

Deprecated.

Returns the role for the specified column number.

Parameters:

n_ - The column index for the role. This is one of COLUMN_VIEWER or COLUMN_EDITOR

Returns:

The role for the specified column number, or null if the column does not map to a role

addViewers

public void addViewers(java.lang.String[] users_)

Deprecated.

Adds to the list of users that have viewer permissions.

Parameters:

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

getViewers

public java.lang.String[] getViewers()

Deprecated.

Returns the list of users that have viewer permissions.

Returns:

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

See Also:

setViewers(String[])

setViewers

public void setViewers(java.lang.String[] users_)

Deprecated.

Sets the list of users that have viewer permissions.

Parameters:

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

See Also:

getViewers()

removeViewers

public void removeViewers(java.lang.String[] users_)

Deprecated.

Removes from the list of users that have viewer permissions.

Parameters:

users_ - an Array containing the unique IDs (usernames) of the users to be removed

addViewerGroups

public void addViewerGroups(java.lang.Long[] groups_)

Deprecated.

Adds to the list of groups that have viewer permissions.

Parameters:

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

getViewerGroups

public java.lang.Long[] getViewerGroups()

Deprecated.

Returns the list of groups that have viewer permissions.

Returns:

an Array containing the unique IDs of the groups

See Also:

setViewerGroups(Long[])

setViewerGroups

public void setViewerGroups(java.lang.Long[] groups_)

Deprecated.

Sets the list of groups with viewer permissions.

Parameters:

groups_ - an Array containing the unique IDs of the groups

See Also:

getViewerGroups()

removeViewerGroups

public void removeViewerGroups(java.lang.Long[] groups_)

Deprecated.

Removes from the list of groups with viewer permissions.

Parameters:

groups_ - an Array containing the unique IDs of the groups to be removed

addEditors

public void addEditors(java.lang.String[] users_)

Deprecated.

Adds to the list of users that have editor permissions.

Parameters:

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

getEditors

public java.lang.String[] getEditors()

Deprecated.

Returns the list of users that have editor permissions.

Returns:

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

See Also:

setEditors(String[])

setEditors

public void setEditors(java.lang.String[] users_)

Deprecated.

Sets the list of users that have editor permissions.

Parameters:

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

See Also:

getEditors()

removeEditors

public void removeEditors(java.lang.String[] users_)

Deprecated.

Removes from the list of users that have editor permissions.

Parameters:

users_ - an Array containing the unique IDs (usernames) of the users to be removed

addEditorGroups

public void addEditorGroups(java.lang.Long[] groups_)

Deprecated.

Adds to the list of groups that have editor permissions.

Parameters:

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

getEditorGroups

public java.lang.Long[] getEditorGroups()

Deprecated.

Returns the list of groups that have editor permissions.

Returns:

an Array containing the unique IDs of the groups

See Also:

setEditorGroups(Long[])

setEditorGroups

public void setEditorGroups(java.lang.Long[] groups_)

Deprecated.

Sets the list of groups with editor permissions.

Parameters:

groups_ - an Array containing the unique IDs of the groups

See Also:

getEditorGroups()

removeEditorGroups

public void removeEditorGroups(java.lang.Long[] groups_)

Deprecated.

Removes from the list of groups with editor permissions.

Parameters:

groups_ - an Array containing the unique IDs of the groups to be removed