Overview

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

bonds

bond[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

checkedOut

boolean

This member is true if the family member is true and the document is currently checked out for editing.

checkedOutBy

actor

The actor who currently has a document checked out for editing.

checkedOutOn

dateTime

The time at which a checked-out document was checked out for editing.

checkoutComments

string

If this item represents a document that is currently checked out for editing, then the checkoutComments member stores the comments that describe the edits made for the checkout.

collabId

beeId

CollabId of the snapshot

content

content

The identifiable simple content object associated with this document.

contentSnapshotId

string

ID marking the state of the document at the time that the content was last updated.

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

The description of the document, stored with rich text markup.

family

boolean

This member is true if this item represents a document with versions.

lastModifiedByName

string

The name of the actor who last modified the document.

locks

lock[]

All locks that are currently held on the document.

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.

parentFamily

anyType

If this item represents a specific version of a document, then this member can be loaded to get the overall document (the family) of which this item is a part.

parentVersion

version

If this item represents a specific version of a document, then this member can be loaded to get the metadata for this particular version.

path

string

The fully-qualified path of the document.

pendingWorkflowStatus

pendingWorkflowStatus

The pending workflow status for this document if there is a pending workflow for this document.

properties

collabProperties

The properties of the artifact that are shared among all the actors

remoteItemId

anyType

The id of the remote document in external repository.

representativeVersion

version

If this item represents a document with versions, then this member can be loaded to get the metadata for the latest version or the working copy, depending on whether the current actor has the document checked out for editing.

representativeVersionable

anyType

If this item represents a document with versions, then this member can be loaded to get the content of the latest version or the working copy, depending on whether the current actor has the document checked out for editing.

sealed

boolean

Whether the document is sealed for editing by the information rights management feature.

size

long

The user-visible current size of the document. If the document has multiple versions, this member displays the size of the latest version.

snapshotId

string

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

totalSize

long

The total size of the document and all of its versions. This is the amount that the document as a whole contributes to the quota of its containing workspace.

userCreatedOn

dateTime

The user creation date (if created offline)

userModifiedOn

dateTime

The user last modified date (if modified offline)

version

boolean

This member is true if this item represents the content of a specific version of a document.

versionControlled

boolean

This member is true if the document is under version control and is either a family, version, or working copy.

versionHistory

version[]

List of the metadata for each version of the document. These types can be loaded to retrieve the version numbers and comments associated with each version.

versionableHistory

anyType[]

List of all versions of the document. These types can be loaded to retrieve the actual document content associated with each version.

viewCount

int

The number of times this document has been viewed

viewer

actor

The actor for which this artifact snapshot was loaded. All the artifact viewer properties in this snapshot are loaded for this actor.

viewerProperties

collabProperties

The viewer properties of the artifact that are private to loading actor

workingCopy

boolean

This member is true if this item represents the content of a checked-out document.

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:remoteDocument xsi:type="obh:remoteDocument" 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>
        <bonds>your_bond_0</bonds>
        <bonds>your_bond_1</bonds>
        <bonds>your_bond_2</bonds>
        <changeStatus>your_changeStatus_0</changeStatus>
        <checkedOut>your_boolean_0</checkedOut>
        <checkedOutBy>your_actor_0</checkedOutBy>
        <checkedOutOn>your_dateTime_0</checkedOutOn>
        <checkoutComments>your_string_0</checkoutComments>
        <collabId>your_beeId_0</collabId>
        <content>your_content_0</content>
        <contentSnapshotId>your_string_0</contentSnapshotId>
        <createdOn>your_dateTime_0</createdOn>
        <creator>your_actor_0</creator>
        <deleted>your_boolean_0</deleted>
        <description>your_string_0</description>
        <family>your_boolean_0</family>
        <lastModifiedByName>your_string_0</lastModifiedByName>
        <locks>your_lock_0</locks>
        <locks>your_lock_1</locks>
        <locks>your_lock_2</locks>
        <modifiedBy>your_actor_0</modifiedBy>
        <modifiedOn>your_dateTime_0</modifiedOn>
        <name>your_string_0</name>
        <parent>your_entity_0</parent>
        <parentFamily>your_anyType_0</parentFamily>
        <parentVersion>your_version_0</parentVersion>
        <path>your_string_0</path>
        <pendingWorkflowStatus>your_pendingWorkflowStatus_0</pendingWorkflowStatus>
        <properties>your_collabProperties_0</properties>
        <remoteItemId>your_anyType_0</remoteItemId>
        <representativeVersion>your_version_0</representativeVersion>
        <representativeVersionable>your_anyType_0</representativeVersionable>
        <sealed>your_boolean_0</sealed>
        <size>your_long_0</size>
        <snapshotId>your_string_0</snapshotId>
        <totalSize>your_long_0</totalSize>
        <userCreatedOn>your_dateTime_0</userCreatedOn>
        <userModifiedOn>your_dateTime_0</userModifiedOn>
        <version>your_boolean_0</version>
        <versionControlled>your_boolean_0</versionControlled>
        <versionHistory>your_version_0</versionHistory>
        <versionHistory>your_version_1</versionHistory>
        <versionHistory>your_version_2</versionHistory>
        <versionableHistory>your_anyType_0</versionableHistory>
        <versionableHistory>your_anyType_1</versionableHistory>
        <versionableHistory>your_anyType_2</versionableHistory>
        <viewCount>your_int_0</viewCount>
        <viewer>your_actor_0</viewer>
        <viewerProperties>your_collabProperties_0</viewerProperties>
        <workingCopy>your_boolean_0</workingCopy>
</obh:remoteDocument>

Referenced By Representaions

Not Referenced Directly by Representations