Interface WebSecurityRole
-
- All Superinterfaces:
EnumWebPersistableState
,KeyedObject
,Persistable
,WebDisplayUnit
,WebFeatures
,WebObjectInfo
,WebPromptSite
public interface WebSecurityRole extends WebObjectInfo, Persistable
The WebSecurityRole interface represents a security role object, which is a first-class object. A security role can be assigned to a user on a project to give a user or group access to the project or give additional privileges to any user or group which the role is assigned to. The definition of the role, aside from the information inherited fromWebObjectInfo
, is simply a single editableWebEditablePrivileges
collection, representing the list of privileges associated with the security role.- Since:
- MicroStrategy Web 7.5.2
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebEditablePrivileges
getPrivileges()
Returns aWebEditablePrivileges
collection, which can be used to read and write the privileges in the collection.WebSecurityRoleUsers
getSecurityRoleUsers()
Returns the collection of user-project associations associated with the WebSecurityRole.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebFeatures
isFeatureAvailable, isFeatureAvailable
-
Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo
buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags
-
Methods inherited from interface com.microstrategy.web.objects.WebPromptSite
getPromptInstances
-
-
-
-
Method Detail
-
getPrivileges
WebEditablePrivileges getPrivileges()
Returns aWebEditablePrivileges
collection, which can be used to read and write the privileges in the collection.- Returns:
- A list of privileges, represented by a
WebEditablePrivileges
collection. - Since:
- MicroStrategy Web 8.0.0
-
getSecurityRoleUsers
WebSecurityRoleUsers getSecurityRoleUsers()
Returns the collection of user-project associations associated with the WebSecurityRole.- Returns:
WebSecurityRoleUsers
object which holds the collection of users-projects association.- Since:
- MicroStrategy Web 9.0.0
-
-