Overview

A reminder is an artifact that is used to trigger a reminder action at some timed event.

It associates a timed trigger on the entity (represented by the source member), which can set off an event. A timed trigger can be defined relative to the time of an operation, such as start of a Meeting or the due time of a Task.

A timed trigger can also be defined by absolute time, independent of any operation.

Members

Show inherited members

Projections

Name	Type	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
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.
derivedFrom	defaultReminder	Get the DefaultReminder that was resposible for creating this reminder if in fact, this reminder was created by the application of a DefaultReminder.
enabled	boolean	Get the Enable state for this Reminder.
modifiedBy	actor	The actor that last modified the entity
modifiedOn	dateTime	The date when entity was last modified
name	string	Name of the entity.
nextAbsoluteTriggerTime	dateTime	Get the next absolute time at which this Reminder will trigger. Note that this value can be retrieved, even when only a RelativeTrigger has been specified.
parent	entity	The parent for this entity.
primary	boolean	Get the Primary attribute of the Reminder object.
properties	collabProperties	The properties of the artifact that are shared among all the actors
rule	reminderRule	Get the reminderRule for this Reminder. A ReminderRule specifies a ReminderCondition and ReminderAction that describes how the Reminder should behave.
snapshotId	string	Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.
source	entity	Get the source, which conceptually represents WHAT you are being reminded about. For example, an Invitation or an Assignment could be a valid source.
status	reminderStatus	Get the Status.
trigger	timedTrigger	Trigger time of the reminder. For RelativeTriggers the trigger time is relative to the entity refered to by the Source attribute.
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

Inherits From

artifact

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:reminder xsi:type="obh:reminder" 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>
        <collabId>your_beeId_0</collabId>
        <createdOn>your_dateTime_0</createdOn>
        <creator>your_actor_0</creator>
        <deleted>your_boolean_0</deleted>
        <derivedFrom>your_defaultReminder_0</derivedFrom>
        <enabled>your_boolean_0</enabled>
        <modifiedBy>your_actor_0</modifiedBy>
        <modifiedOn>your_dateTime_0</modifiedOn>
        <name>your_string_0</name>
        <nextAbsoluteTriggerTime>your_dateTime_0</nextAbsoluteTriggerTime>
        <parent>your_entity_0</parent>
        <primary>your_boolean_0</primary>
        <properties>your_collabProperties_0</properties>
        <rule>your_reminderRule_0</rule>
        <snapshotId>your_string_0</snapshotId>
        <source>your_entity_0</source>
        <status>your_reminderStatus_0</status>
        <trigger>your_timedTrigger_0</trigger>
        <userCreatedOn>your_dateTime_0</userCreatedOn>
        <userModifiedOn>your_dateTime_0</userModifiedOn>
        <viewer>your_actor_0</viewer>
        <viewerProperties>your_collabProperties_0</viewerProperties>
</obh:reminder>

Overview

Members

Hierarchy

Examples

XML Example

Referenced By Representaions