A script enabled browser is required for this page to function properly
Oracle® Beehive RESTful Web Services API Reference Release 2 (2.0.1.7)
Overview
A preference set is a container of various preference settings declaring
the choices, desires, course of actions, or customizations per actor, group,
or scope. A preference set captures the related properties for some
functional area.
Preference set naming guidelines
A names must use alpha-numeric ASCII characters only and must not include spaces
Special characters are discouraged; preference set names may be used as
keys in resource bundles for internationalization
A name must clearly indicate usage
A name must be in init caps with the first letter of each word in uppercase
A name should preferably avoid a 'Preferences' suffix
A name can be up to 64 characters long; smaller is better
A preference set can only extend from another with the same name (or template)
The number of preference sets per profile must be small; use property naming
effectively to further organize preferences
Members
Projections
BASIC
EMPTY
FULL
META
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.
description
string
Description of this preference set.
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.
preferences
associativeArray <string , preferenceProperty >
Preference properties contained in this preference set.
snapshotId
string
Contains the snapshot identifier for this snapshot. Snapshot identifiers
are used to implement optimistic locking on the server.
template
basicTemplate
Optional template for this preference set.
Hierarchy
Examples
Below are examples in JSON and 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:preferenceSet xsi:type="obh:preferenceSet" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<obh:attachedMarkers>your_marker_0 your_marker_1 your_marker_2
<obh:attachedReminders>your_reminder_0 your_reminder_1 your_reminder_2
<obh:attachedSubscriptions>your_subscription_0 your_subscription_1 your_subscription_2
<obh:collabId>your_beeId_0
<obh:createdOn>your_dateTime_0 </obh:createdOn>
<obh:creator>your_actor_0
<obh:deleted>your_boolean_0 </obh:deleted>
<obh:description>your_string_0 </obh:description>
<obh:modifiedBy>your_actor_0
<obh:modifiedOn>your_dateTime_0 </obh:modifiedOn>
<obh:name>your_string_0 </obh:name>
<obh:parent>your_entity_0
<obh:preferences>your_associativeArray_0
<obh:snapshotId>your_string_0 </obh:snapshotId>
<obh:template>your_basicTemplate_0
</obh:preferenceSet>
JSON Example
(show inherited members)
{
"beeType":"preferenceSet",
"attachedMarkers":[your_{http://www.oracle.com/beehive}attachedMarkers_as_marker0 your_{http://www.oracle.com/beehive}attachedMarkers_as_marker1 your_{http://www.oracle.com/beehive}attachedMarkers_as_marker2
"attachedReminders":[your_{http://www.oracle.com/beehive}attachedReminders_as_reminder0 your_{http://www.oracle.com/beehive}attachedReminders_as_reminder1 your_{http://www.oracle.com/beehive}attachedReminders_as_reminder2
"attachedSubscriptions":[your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription0 your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription1 your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription2
"collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0
"createdOn":"your_{http://www.oracle.com/beehive}createdOn_as_dateTime0",
"creator":{ your_{http://www.oracle.com/beehive}creator_as_actor0
"deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
"description":"your_{http://www.oracle.com/beehive}description_as_string0",
"modifiedBy":{ your_{http://www.oracle.com/beehive}modifiedBy_as_actor0
"modifiedOn":"your_{http://www.oracle.com/beehive}modifiedOn_as_dateTime0",
"name":"your_{http://www.oracle.com/beehive}name_as_string0",
"parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0
"preferences":{ your_{http://www.oracle.com/beehive}preferences_as_associativeArray0
"snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
"template":{ your_{http://www.oracle.com/beehive}template_as_basicTemplate0
}
XML Schema
<xs:complexType final="extension restriction" name="preferenceSet">
<xs:complexContent>
<xs:extension base="tns:entity">
<xs:sequence>
<xs:element minOccurs="0" name="description" type="xs:string"/>
<xs:element minOccurs="0" name="preferences" type="tns:associativeArray"/>
<xs:element minOccurs="0" name="template" type="tns:basicTemplate"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
References
The following data represents the references to preferenceSet
Referenced By Resources
Referenced By Representaions
Legal Notices
