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

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.

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

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:preferenceSet xsi:type="obh:preferenceSet" 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>
         <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>
         <preferences>your_associativeArray_0</preferences>
         <snapshotId>your_string_0</snapshotId>
         <template>your_basicTemplate_0</template>
 </obh:preferenceSet>

Referenced By Representaions