Overview

The RoleDefinition Entity.

A RoleDefinition is a set of Privileges to be granted, a set of AccessTypes to be granted, and a set of AccessTypes to be denied. A RoleDefinition by itself does not have any effect; it must be referenced from an AssignedRole for the Privileges and AccessTypes to take effect within a Scope specified by the AssignedRole.

A RoleDefinition can be marked AlwaysEnabled (meaning it is always enabled, by default, and can not be disabled). AssignedRoles using RoleDefinitions that are not marked AlwaysEnabled can be enabled through methods on the UserContext.

The following specifies which attributes are loaded when each Projection type is used to load a RoleDefinition snapshot:

Projection.EMPTY loads the following:

  • CollabId
Projection.BASIC loads the Projection.EMPTY fields and the following:
  • SnapshotId
  • Name
  • Parent (The owning Scope)
  • ModifiedBy
  • ModifiedOn
  • Deleted
  • Description
  • Privileges
  • AccessTypes
  • AlwaysEnabled
Projection.META loads Projection.Empty and Projection.BASIC fields and the following:
  • Creator
  • CreatedOn

Projection.FULL does not load any additional fields.

The RoleDefinition's LocalACL (LACL) is managed using an AccessControlFieldsUpdater.

The RoleDefinition snapshot and the data it contains are immutable.

Members

Show inherited members

Projections
Name Type Required Description

accessTypes

accessTypes
Returns the AccessTypes.

alwaysEnabled

boolean
Returns the always enabled status.

attachedMarkers

marker[]
Set of marker elements associated with the entity.

attachedReminders

reminder[]
List of reminders attached to the entity

attachedSubscriptions

subscription[]
List of subscriptions attached to the entity

collabId

beeId
CollabId of the snapshot

createdOn

dateTime
Entity's creation date

creator

actor
The actor that created this entity

deleted

boolean
Deletion flag. If this property is set to true the entity is deleted.

description

string
Returns the Description.

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

parent

entity
The parent for this entity.

privileges

privilege[]
Returns the Privileges.

snapshotId

string
Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

Hierarchy

Inherits From

Examples

Below are examples in XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:roleDefinition xsi:type="obh:roleDefinition" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <accessTypes>your_accessTypes_0</accessTypes>
         <alwaysEnabled>your_boolean_0</alwaysEnabled>
         <attachedMarkers>your_marker_0</attachedMarkers>
        <attachedMarkers>your_marker_1</attachedMarkers>
        <attachedMarkers>your_marker_2</attachedMarkers>
         <attachedReminders>your_reminder_0</attachedReminders>
        <attachedReminders>your_reminder_1</attachedReminders>
        <attachedReminders>your_reminder_2</attachedReminders>
         <attachedSubscriptions>your_subscription_0</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_1</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_2</attachedSubscriptions>
         <collabId>your_beeId_0</collabId>
         <createdOn>your_dateTime_0</createdOn>
         <creator>your_actor_0</creator>
         <deleted>your_boolean_0</deleted>
         <description>your_string_0</description>
         <modifiedBy>your_actor_0</modifiedBy>
         <modifiedOn>your_dateTime_0</modifiedOn>
         <name>your_string_0</name>
         <parent>your_entity_0</parent>
         <privileges>your_privilege_0</privileges>
        <privileges>your_privilege_1</privileges>
        <privileges>your_privilege_2</privileges>
         <snapshotId>your_string_0</snapshotId>
 </obh:roleDefinition>

Referenced By Representaions