Class AdminConsoleRoleMap
java.lang.Object
com.appiancorp.suiteapi.common.RoleMap
com.appiancorp.suiteapi.administration.AdminConsoleRoleMap
- All Implemented Interfaces:
XMLable,Serializable,Map
Deprecated.
This class pertains to the legacy admin console,
which will be replaced by the Appian Administration Console over the coming releases.
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:
-
Nested Class Summary
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.The editor role.static final StringDeprecated.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_UUIDSFields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddEditorGroups(Long[] groups_) Deprecated.Adds to the list of groups that have editor permissions.voidaddEditors(String[] users_) Deprecated.Adds to the list of users that have editor permissions.voidaddViewerGroups(Long[] groups_) Deprecated.Adds to the list of groups that have viewer permissions.voidaddViewers(String[] users_) Deprecated.Adds to the list of users that have viewer permissions.Long[]Deprecated.Returns the list of groups that have editor permissions.String[]Deprecated.Returns the list of users that have editor permissions.static StringgetRoleForColumn(int n_) Deprecated.Returns the role for the specified column number.Long[]Deprecated.Returns the list of groups that have viewer permissions.String[]Deprecated.Returns the list of users that have viewer permissions.voidremoveEditorGroups(Long[] groups_) Deprecated.Removes from the list of groups with editor permissions.voidremoveEditors(String[] users_) Deprecated.Removes from the list of users that have editor permissions.voidremoveViewerGroups(Long[] groups_) Deprecated.Removes from the list of groups with viewer permissions.voidremoveViewers(String[] users_) Deprecated.Removes from the list of users that have viewer permissions.voidsetEditorGroups(Long[] groups_) Deprecated.Sets the list of groups with editor permissions.voidsetEditors(String[] users_) Deprecated.Sets the list of users that have editor permissions.voidsetViewerGroups(Long[] groups_) Deprecated.Sets the list of groups with viewer permissions.voidsetViewers(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, valuesMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Field Details
-
VIEWER
Deprecated.The viewer role.- See Also:
-
EDITOR
Deprecated.The editor role.- See Also:
-
-
Constructor Details
-
AdminConsoleRoleMap
public AdminConsoleRoleMap()Deprecated.
-
-
Method Details
-
getRoleForColumn
Deprecated.Returns the role for the specified column number.- Parameters:
n_- The column index for the role. This is one ofCOLUMN_VIEWERorCOLUMN_EDITOR- Returns:
- The role for the specified column number, or
nullif the column does not map to a role
-
addViewers
Deprecated.Adds to the list of users that have viewer permissions.- Parameters:
users_- anArraycontaining the unique IDs (usernames) of the users to be added
-
getViewers
Deprecated.Returns the list of users that have viewer permissions.- Returns:
- an
Arraycontaining the unique IDs (usernames) of the users - See Also:
-
setViewers
Deprecated.Sets the list of users that have viewer permissions.- Parameters:
users_- anArraycontaining the unique IDs (usernames) of the users- See Also:
-
removeViewers
Deprecated.Removes from the list of users that have viewer permissions.- Parameters:
users_- anArraycontaining the unique IDs (usernames) of the users to be removed
-
addViewerGroups
Deprecated.Adds to the list of groups that have viewer permissions.- Parameters:
groups_- anArraycontaining the unique IDs of the groups to be added
-
getViewerGroups
Deprecated.Returns the list of groups that have viewer permissions.- Returns:
- an
Arraycontaining the unique IDs of the groups - See Also:
-
setViewerGroups
Deprecated.Sets the list of groups with viewer permissions.- Parameters:
groups_- anArraycontaining the unique IDs of the groups- See Also:
-
removeViewerGroups
Deprecated.Removes from the list of groups with viewer permissions.- Parameters:
groups_- anArraycontaining the unique IDs of the groups to be removed
-
addEditors
Deprecated.Adds to the list of users that have editor permissions.- Parameters:
users_- anArraycontaining the unique IDs (usernames) of the users to be added
-
getEditors
Deprecated.Returns the list of users that have editor permissions.- Returns:
- an
Arraycontaining the unique IDs (usernames) of the users - See Also:
-
setEditors
Deprecated.Sets the list of users that have editor permissions.- Parameters:
users_- anArraycontaining the unique IDs (usernames) of the users- See Also:
-
removeEditors
Deprecated.Removes from the list of users that have editor permissions.- Parameters:
users_- anArraycontaining the unique IDs (usernames) of the users to be removed
-
addEditorGroups
Deprecated.Adds to the list of groups that have editor permissions.- Parameters:
groups_- anArraycontaining the unique IDs of the groups to be added
-
getEditorGroups
Deprecated.Returns the list of groups that have editor permissions.- Returns:
- an
Arraycontaining the unique IDs of the groups - See Also:
-
setEditorGroups
Deprecated.Sets the list of groups with editor permissions.- Parameters:
groups_- anArraycontaining the unique IDs of the groups- See Also:
-
removeEditorGroups
Deprecated.Removes from the list of groups with editor permissions.- Parameters:
groups_- anArraycontaining the unique IDs of the groups to be removed
-