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
Defines the roles of users and groups for an object.
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
protected final String
protected final String
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAdministratorGroups
(Long[] grids_) Appends to the groups who have administrative permissions.void
addAdministrators
(String[] unames_) Appends to the users who have administrative permissions.Long[]
Retrieves the groups who have administrative permissions.String[]
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
-
Field Details
-
ADMINISTRATOR
- See Also:
-
TYPE_USER
- See Also:
-
TYPE_GROUP
- See Also:
-
-
Constructor Details
-
PublicRoleMap
public PublicRoleMap()
-
-
Method Details
-
getAdministrators
Retrieves the users who have administrative permissions.- Returns:
- an
Array
containing the unique IDs (usernames) of the users. - See Also:
-
getAdministratorGroups
Retrieves the groups who have administrative permissions.- Returns:
- an
Array
containing the unique IDs of the groups. - See Also:
-
setAdministrators
Sets the users who have administrative permissions.- Parameters:
unames_
- anArray
containing the unique IDs (usernames) of the users.- See Also:
-
setAdministratorGroups
Sets the groups who have administrative permissions.- Parameters:
grids_
- anArray
containing the unique IDs of the groups- See Also:
-
addAdministrators
Appends to the users who have administrative permissions.- Parameters:
unames_
- anArray
containing the unique IDs (usernames) of the users to be added
-
addAdministratorGroups
Appends to the groups who have administrative permissions.- Parameters:
grids_
- anArray
containing the unique IDs of the groups to be added
-
removeAdministrators
Deletes from the users who have administrative permissions.- Parameters:
unames_
- anArray
containing the unique IDs (usernames) of the users to be deleted
-
removeAdministratorGroups
Deletes from the groups who have administrative permissions.- Parameters:
grids_
- anArray
containing the unique IDs of the groups to be deleted
-