Overview

Entity is a snapshot of a server-side entity instance. It is an immutable object associated with an entity instance which has some of its attributes materialized during a load operation. The set of loaded attributes depends on the projection used in load operation. Entities are created using a creator object of the corresponding type and entity attributes are updated using the corresponding updater object. From an object model point of view, an entity is a tuple with a globally unique entity ID and an optional name. An entity's name is mutable. Virtually all manipulable objects are entities. Access to every entity is controlled through access control rules. Basically, each entity can define one or more operations that can be performed on it and for each operation specify one or more privileges that the requesting actor must carry in order to be allowed to perform the operation. Note that we allow owner to be either a single actor, or a group. The actor that made the entity come into existence is the creator of the entity and this value cannot be changed. Each entity can have zero or more labels associated with it.

Members

Show inherited members

Projections
Name Type Required Description

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.

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.

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:entity xsi:type="obh:entity" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <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>
        <modifiedBy>your_actor_0</modifiedBy>
        <modifiedOn>your_dateTime_0</modifiedOn>
        <name>your_string_0</name>
        <parent>your_entity_0</parent>
        <snapshotId>your_string_0</snapshotId>
</obh:entity>

Referenced By Representaions