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)
E16658-04
Overview
The EventType
provide the metadata for a class of events.
It specifies the name and type of properties that should be present in the
events of that type. The event subscribers write the filtering conditions
on event types. If the condition is true the event handlers get executed.
Members
Show inherited 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
attributes
attributeDescriptor []
The attribute types of a particular EventType is returned by getAttributes()
.
Used the GUI teams to show list of attributes that can be used in building the
RuleCondition
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
returns the description of the event type
displayName
string
javaClassName
string
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.
payloadType
string
returns the payload type. In the current implementation
this is PLSQL ADT Type.
snapshotId
string
Contains the snapshot identifier for this snapshot. Snapshot identifiers
are used to implement optimistic locking on the server.
synchronous
boolean
returns boolean whether the event is synchronous or not.
If the event type is synchronous, the event handlers get executed before the
call is returned to the event publisher. The event handlers in synchronous events
are only PL/SQL calls.
If the event type is Asynchronous event types, the event is put into event queue and
the events are processed by event handlers Asynchronusly.
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:eventDefinition xsi:type="obh:eventDefinition" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<obh:attachedMarkers>your_marker_0 </obh:attachedMarkers>
<obh:attachedMarkers>your_marker_1 </obh:attachedMarkers>
<obh:attachedMarkers>your_marker_2 </obh:attachedMarkers>
<obh:attachedReminders>your_reminder_0 </obh:attachedReminders>
<obh:attachedReminders>your_reminder_1 </obh:attachedReminders>
<obh:attachedReminders>your_reminder_2 </obh:attachedReminders>
<obh:attachedSubscriptions>your_subscription_0 </obh:attachedSubscriptions>
<obh:attachedSubscriptions>your_subscription_1 </obh:attachedSubscriptions>
<obh:attachedSubscriptions>your_subscription_2 </obh:attachedSubscriptions>
<obh:attributes>your_attributeDescriptor_0 </obh:attributes>
<obh:attributes>your_attributeDescriptor_1 </obh:attributes>
<obh:attributes>your_attributeDescriptor_2 </obh:attributes>
<obh:collabId>your_beeId_0 </obh:collabId>
<obh:createdOn>your_dateTime_0 </obh:createdOn>
<obh:creator>your_actor_0 </obh:creator>
<obh:deleted>your_boolean_0 </obh:deleted>
<obh:description>your_string_0 </obh:description>
<obh:displayName>your_string_0 </obh:displayName>
<obh:javaClassName>your_string_0 </obh:javaClassName>
<obh:modifiedBy>your_actor_0 </obh:modifiedBy>
<obh:modifiedOn>your_dateTime_0 </obh:modifiedOn>
<obh:name>your_string_0 </obh:name>
<obh:parent>your_entity_0 </obh:parent>
<obh:payloadType>your_string_0 </obh:payloadType>
<obh:snapshotId>your_string_0 </obh:snapshotId>
<obh:synchronous>your_boolean_0 </obh:synchronous>
</obh:eventDefinition>
JSON Example
(show inherited members)
{
"beeType":"eventDefinition",
"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 }
],
"attributes":[
{ your_{http://www.oracle.com/beehive}attributes_as_attributeDescriptor0 },
{ your_{http://www.oracle.com/beehive}attributes_as_attributeDescriptor1 },
{ your_{http://www.oracle.com/beehive}attributes_as_attributeDescriptor2 }
],
"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",
"displayName":"your_{http://www.oracle.com/beehive}displayName_as_string0",
"javaClassName":"your_{http://www.oracle.com/beehive}javaClassName_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 },
"payloadType":"your_{http://www.oracle.com/beehive}payloadType_as_string0",
"snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
"synchronous":your_{http://www.oracle.com/beehive}synchronous_as_boolean0
}
XML Schema
<xs:complexType name="eventDefinition">
<xs:complexContent>
<xs:extension base="tns:entity">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="attributes" nillable="true" type="tns:attributeDescriptor"/>
<xs:element minOccurs="0" name="description" type="xs:string"/>
<xs:element minOccurs="0" name="displayName" type="xs:string"/>
<xs:element minOccurs="0" name="javaClassName" type="xs:string"/>
<xs:element minOccurs="0" name="payloadType" type="xs:string"/>
<xs:element name="synchronous" type="xs:boolean"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
References
The following data represents the references to eventDefinition
Referenced By Resources
Referenced By Representaions
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices