Class ApplicationRoleMap
java.lang.Object
com.appiancorp.suiteapi.applications.ApplicationRoleMap
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionLong[]
Retrieves the groups who have administrative permissions.String[]
Retrieves the users who have administrative permissions.String[]
getDeny()
The users in the deny role.Long[]
The list of groups in the deny role.Long[]
Retrieves the groups who have authoring (read/write) permissions.String[]
Retrieves the users who have editor (read/write) permissions.Long[]
Retrieves the groups who have read-only permissions.String[]
Retrieves the users who have read-only permissions.void
setAdministratorGroups
(Long[] groupIds) Sets the groups who have administrative permissions.void
setAdministrators
(String[] usernames) Sets the users who have administrative permissions.void
void
A user assigned to the "Deny" level, either directly or via group membership, will NOT have ANY privileges on the application, regardless of membership in any other security level.void
setDenyGroups
(Long[] groupIds) A group assigned to the "Deny" level, will NOT have ANY privileges on the application, regardless of membership in any other security level.void
setEditorGroups
(Long[] groupIds) Sets the groups who have editor (read/write) permissions.void
setEditors
(String[] usernames) Sets the users who have authoring (read/write) permissions.void
setViewerGroups
(Long[] groupIds) Sets the groups who have read-only permissions.void
setViewers
(String[] usernames) Sets the users who have read-only permissions.toString()
-
Constructor Details
-
ApplicationRoleMap
public ApplicationRoleMap() -
ApplicationRoleMap
-
-
Method Details
-
getAdministrators
Retrieves the users who have administrative permissions.- Returns:
- a list containing the unique IDs of the users
- See Also:
-
getAdministratorGroups
Retrieves the groups who have administrative permissions.- Returns:
- a list containing the unique IDs of the groups
- See Also:
-
setAdministrators
Sets the users who have administrative permissions.- Parameters:
usernames
- a list containing the usernames- See Also:
-
setAdministratorGroups
Sets the groups who have administrative permissions.- Parameters:
groupIds
- a list containing the ids of the groups- See Also:
-
getEditors
Retrieves the users who have editor (read/write) permissions.- Returns:
- a list containing the unique IDs of the users who have editor (read/write) permissions
-
setEditors
Sets the users who have authoring (read/write) permissions.- Parameters:
usernames
- a list containing the unique IDs of the users- See Also:
-
#getAuthors()
-
getEditorGroups
Retrieves the groups who have authoring (read/write) permissions.- Returns:
- a list containing the unique IDs of the groups
- See Also:
-
#setAuthorGroups(Long[])
-
setEditorGroups
Sets the groups who have editor (read/write) permissions.- Parameters:
groupIds
- a list containing the group ids.
-
getViewers
Retrieves the users who have read-only permissions.- Returns:
- a list containing the unique IDs of the users who have read-only permissions
-
getViewerGroups
Retrieves the groups who have read-only permissions.- Returns:
- a list containing the unique IDs the groups who have read-only permissions
- See Also:
-
#setReaderGroups(Long[])
-
setViewers
Sets the users who have read-only permissions.- Parameters:
usernames
- a list containing the unique IDs of the users
-
setViewerGroups
Sets the groups who have read-only permissions.- Parameters:
groupIds
- a list containing the unique IDs of the groups
-
setDeny
A user assigned to the "Deny" level, either directly or via group membership, will NOT have ANY privileges on the application, regardless of membership in any other security level. "Deny" also overrides implicit viewer privileges granted by the "public" configuration. The exception is a System Administrator, whose privileges may not be overridden.- Parameters:
usernames
- The list of usernames to be added to the Deny role.
-
getDeny
The users in the deny role.- Returns:
- The users in the deny role.
- See Also:
-
setDenyGroups
A group assigned to the "Deny" level, will NOT have ANY privileges on the application, regardless of membership in any other security level. "Deny" also overrides implicit viewer privileges granted by the "public" configuration. The exception is a System Administrator, whose privileges may not be overridden.- Parameters:
groupIds
- The list of groups to be added to the Deny role.
-
getDenyGroups
The list of groups in the deny role.- Returns:
- the list of groups in the deny role.
-
getContentRoleMap
-
setContentRoleMap
-
toString
-