Oracle Beehive
  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Contents

Overview

A Folder is an Artifact whose main purpose is to contain other Artifacts. Every Folder except a root Folder will have exactly one parent Folder. Subclasses of Folder should enforce their own semantics on members of the Folder. Every Artifact must be contained in exactly one Folder (primary affinity). However, other Folders may refer (or link) to the Artifact (secondary affinity). Before a Folder is moved from one Scope to another Scope, the system must check that the Folder Policies are compatible with the higher level Policies of the destination Scope. Compatibility has two layers of meaning: a Folder cannot define Policies that conflict with those of its primary container, and Policies at the Folder scope can be extended from those defined at the primary container scope. This means that there are two types of Policies a Folder can have: 1.) Policies inherited from its parent container or Workspace. 2.) Policies not inherited from its parent container. These are the Policies created at Folder level. When a Folder is moved between Workspaces, type 1 Policies specified above should not be allowed to move with the Folder. A subset of type 2, Policies that are compatible with the new higher scope, are moved with the Folder. A Folder can be shared among different Workspaces. At any time, there's one primary container for a Folder. Folder level Policies must be compatible with the Policies of the primary container. Note that a Workspace cannot be moved to a different Organization but a Folder can be moved to a Workspace belonging to a different Organization.

Members

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

availableMarkers

marker[]

Set of available Markers.

bonds

bond[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

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

Description of the Folder.

elementCount

int

The number of elements in the Folder.

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.

policies

policy[]

Set of Policies.

properties

collabProperties

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

snapshotId

string

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

userCreatedOn

dateTime

The user creation date (if created offline)

userModifiedOn

dateTime

The user last modified date (if modified offline)

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

Hierarchy

folder is an abstract type. It cannot directly be used. Rather, one of its subtypes must be used

Inherits From

Inherited By

Applied Markers

XML Schema


<xs:complexType abstract="true" name="folder">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="availableMarkers" nillable="true" type="tns:marker"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element name="elementCount" type="xs:int"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="policies" nillable="true" type="tns:policy"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to folder

Referenced By Resources

Usage Resource Method
Response Trash List Subfolders

Referenced By Representaions

Not Referenced Directly by Representations