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
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:
-
Nested Class Summary
-
Field Summary
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addEditorGroups
(Long[] id_) Adds theGroup
s identified by given ID's as editors to existing array of Group Editors.void
addEditors
(String[] id_) Adds theUser
s identified by given usernames as editors to existing array of Editors.void
addViewerGroups
(Long[] id_) Adds theGroup
s identified by given ID's as viewers to existing array of Group Viewers.void
addViewers
(String[] id_) Adds theUser
s identified by given usernames as viewers to existing array of Viewers.Long[]
Returns the ID's ofGroup
s whose role is Editor of object.String[]
Returns the usernames ofUser
s whose role is Editor of object.Long[]
Returns the ID's ofGroup
s whose role is Viewer of object.String[]
Returns the usernames ofUser
s whose role is Viewer of object.void
removeEditorGroups
(Long[] id_) Removes theGroup
s identified by given ID's as editors.void
removeEditors
(String[] id_) Removes theUser
s identified by given usernames as editors.void
removeViewerGroups
(Long[] id_) Removes theGroup
s identified by given ID's as viewers.void
removeViewers
(String[] id_) Removes theUser
s identified by given usernames as viewers.void
setEditorGroups
(Long[] id_) Sets theGroup
s identified by given ID's as editors.void
setEditors
(String[] id_) Sets theUser
s identified by given usernames as editors.void
setViewerGroups
(Long[] id_) Sets theGroup
s identified by given ID's as viewers.void
setViewers
(String[] id_) Sets theUser
s 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
-
Field Details
-
EDITOR
- See Also:
-
VIEWER
- See Also:
-
-
Constructor Details
-
AEVRoleMap
public AEVRoleMap()
-
-
Method Details
-
getEditors
Returns the usernames ofUser
s whose role is Editor of object.- Returns:
- string array of usernames
- See Also:
-
getEditorGroups
Returns the ID's ofGroup
s whose role is Editor of object.- Returns:
- Long array of group ID's
- See Also:
-
getViewers
Returns the usernames ofUser
s whose role is Viewer of object.- Returns:
- string array of usernames
- See Also:
-
getViewerGroups
Returns the ID's ofGroup
s whose role is Viewer of object.- Returns:
- Long array of group ID's
- See Also:
-
setEditors
Sets theUser
s identified by given usernames as editors.- Parameters:
id_
- array of usernames to set as editors- See Also:
-
setEditorGroups
Sets theGroup
s identified by given ID's as editors.- Parameters:
id_
- array ofGroup
ID's to set as editors- See Also:
-
setViewers
Sets theUser
s identified by given usernames as viewers.- Parameters:
id_
- array of usernames to set as viewers- See Also:
-
setViewerGroups
Sets theGroup
s identified by given ID's as viewers.- Parameters:
id_
- array ofGroup
ID's to set as viewers- See Also:
-
addEditors
Adds theUser
s identified by given usernames as editors to existing array of Editors.- Parameters:
id_
- array of usernames to add as editors
-
addEditorGroups
Adds theGroup
s identified by given ID's as editors to existing array of Group Editors.- Parameters:
id_
- array of ID's to add as editors
-
addViewers
Adds theUser
s identified by given usernames as viewers to existing array of Viewers.- Parameters:
id_
- array of usernames to add as viewers
-
addViewerGroups
Adds theGroup
s identified by given ID's as viewers to existing array of Group Viewers.- Parameters:
id_
- array of ID's to add as viewers
-
removeEditors
Removes theUser
s identified by given usernames as editors.- Parameters:
id_
- array of usernames to remove as editors
-
removeEditorGroups
Removes theGroup
s identified by given ID's as editors.- Parameters:
id_
- array of ID's to remove as editors
-
removeViewers
Removes theUser
s identified by given usernames as viewers.- Parameters:
id_
- array of usernames to remove as viewers
-
removeViewerGroups
Removes theGroup
s identified by given ID's as viewers.- Parameters:
id_
- array of ID's to remove as viewers
-