- Since:
- 100.0.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Signifies the realm a privilege belongs to.static enum
Signifies the user role a privilege belongs to.static enum
An enumeration of the fine-grained operation subtypes a portal privilege can permit.static enum
Signifies the particular type of operation a privilege permits. -
Method Summary
Modifier and TypeMethodDescriptiongetRealm()
Gets the realm this privilege belongs to.getRole()
Gets the role this privilege belongs to.Gets the fine-grained operation subtype this privilege permits.Gets the subtype name for this privilege.getType()
Gets the particular type of operation this privilege permits.Gets the type name for this privilege.
-
Method Details
-
getRealm
Gets the realm this privilege belongs to.- Returns:
- the realm
- Since:
- 100.0.0
-
getRole
Gets the role this privilege belongs to.- Returns:
- the role
- Since:
- 100.0.0
-
getType
Gets the particular type of operation this privilege permits.- Returns:
- the type of operation
- Since:
- 100.0.0
-
getTypeName
Gets the type name for this privilege.Generally, the type name is the string representation of the
getType()
. However, if the type isPortalPrivilege.Type.UNKNOWN
, the type name is set with the type string found in the portal privilege JSON. This allows this API to handle a new portal privilege type added at the server that is not yet defined as aPortalPrivilege.Type
.- Returns:
- the type name for this privilege
- Since:
- 100.0.0
-
getSubtype
Gets the fine-grained operation subtype this privilege permits.Subtypes control access to a few fine-grained operations. The value is
PortalPrivilege.Subtype.NONE
unless this privilege relates to a fine-grained operation.- Returns:
- the fine-grained operation subtype this privilege permits
- Since:
- 100.12.0
-
getSubtypeName
Gets the subtype name for this privilege.Generally, the subtype name is the string representation of the
getSubtype()
. However, if the subtype isPortalPrivilege.Subtype.UNKNOWN
, the subtype name is set with the subtype string found in the portal privilege JSON. This allows this API to handle a new portal privilege subtype added at the server that is not yet defined as aPortalPrivilege.Subtype
.- Returns:
- the subtype name for this privilege
- Since:
- 100.12.0
-