BusinessEvent (Oracle Fusion Middleware Java API Reference for Oracle SOA Suite Event Delivery Network)

```
public interface BusinessEvent
```
An in-memory representation of a Business Event. Each event has a name which is represented as a QName. The (optional) body of the event is an XML fragment. It also has named headers. Each header can have multiple values. The schema for event bodies and description of its headers are described in an XML Event Description Language (EDL).

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPOSITE_INSTANCE_CREATED_TIME`
`static String`	`CONTEXT` Event Context.
`static String`	`DURABLE` Durability of event subscription.
`static String`	`EDN_BUS_PUBLISHED` Flag indicates if the event is published by EDN Bus.
`static String`	`EVENT_ID` Standard header name.
`static String`	`LOCAL_NAME` Local name of event.
`static String`	`MODE` Mode of event.
`static String`	`NAME`
`static String`	`NAMESPACE` Namespace of event.
`static String`	`OWNER` Owner of event.
`static String`	`PARENT_ID` Standard header name.
`static String`	`PAYLOAD_NAME`
`static String`	`PERSISTENT` Persistent delivery mode of event.
`static String`	`PRIORITY` Event priority for delivery
`static int`	`PRIORITY_NORMAL` Default (normal) event delivery priority value.
`static String`	`PROPERTY_COMPOSITE_INSTANCE_ID`
`static String`	`PROPERTY_CONVERSATION_ID`
`static String`	`PROPERTY_ECID`
`static String`	`PROPERTY_PARENT_COMPONENT_INSTANCE_ID`
`static String`	`PUBLISHED_TIME` Event's published time.
`static String`	`SOURCE` Source of event.
`static String`	`TIME_TO_LIVE` Tim of Live of event.
`static String`	`TRACKING_IS_EDN_EVENT`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Document`	`getAsDoc()` Return the event as a DOM document.
`Element`	`getBody()` Get the XML body of the event.
`String`	`getBodyAsText()` Get the payload body as serialized XML text.
`QName`	`getEventName()` The name of the Event.
`Map<String,Object>`	`getProperties()` Get all the properties of this event.
`Object`	`getProperty(String name)` Get a single value for a header.

- Field Detail
  - NAME
```
static final String NAME
```
    See Also:
    
    Constant Field Values
  - EVENT_ID
```
static final String EVENT_ID
```
    Standard header name. The "id" of an event will be unique and will be set when the event is sent.
    
    See Also:
    
    Constant Field Values
  - PARENT_ID
```
static final String PARENT_ID
```
    Standard header name. The "parent id" of an even is the "id" of the event being processed when this event was published or raised -- if there was one.
    
    See Also:
    
    Constant Field Values
  - PRIORITY
```
static final String PRIORITY
```
    Event priority for delivery
    
    See Also:
    
    Constant Field Values
  - PUBLISHED_TIME
```
static final String PUBLISHED_TIME
```
    Event's published time.
    
    See Also:
    
    Constant Field Values
  - OWNER
```
static final String OWNER
```
    Owner of event.
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
static final String SOURCE
```
    Source of event.
    
    See Also:
    
    Constant Field Values
  - CONTEXT
```
static final String CONTEXT
```
    Event Context.
    
    See Also:
    
    Constant Field Values
  - MODE
```
static final String MODE
```
    Mode of event.
    
    See Also:
    
    Constant Field Values
  - NAMESPACE
```
static final String NAMESPACE
```
    Namespace of event.
    
    See Also:
    
    Constant Field Values
  - LOCAL_NAME
```
static final String LOCAL_NAME
```
    Local name of event.
    
    See Also:
    
    Constant Field Values
  - TIME_TO_LIVE
```
static final String TIME_TO_LIVE
```
    Tim of Live of event.
    
    See Also:
    
    Constant Field Values
  - PERSISTENT
```
static final String PERSISTENT
```
    Persistent delivery mode of event.
    
    See Also:
    
    Constant Field Values
  - DURABLE
```
static final String DURABLE
```
    Durability of event subscription.
    
    See Also:
    
    Constant Field Values
  - EDN_BUS_PUBLISHED
```
static final String EDN_BUS_PUBLISHED
```
    Flag indicates if the event is published by EDN Bus. value: true/false when true - the event is published by EDN Bus when false - the event is NOT published by EDN Bus, e.g. by EDN java client, EDN PL/SQL client, etc. when the property not present - false is assumed.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ECID
```
static final String PROPERTY_ECID
```
    See Also:
    
    Constant Field Values
  - PROPERTY_PARENT_COMPONENT_INSTANCE_ID
```
static final String PROPERTY_PARENT_COMPONENT_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - PROPERTY_CONVERSATION_ID
```
static final String PROPERTY_CONVERSATION_ID
```
    See Also:
    
    Constant Field Values
  - PROPERTY_COMPOSITE_INSTANCE_ID
```
static final String PROPERTY_COMPOSITE_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - COMPOSITE_INSTANCE_CREATED_TIME
```
static final String COMPOSITE_INSTANCE_CREATED_TIME
```
    See Also:
    
    Constant Field Values
  - TRACKING_IS_EDN_EVENT
```
static final String TRACKING_IS_EDN_EVENT
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_NAME
```
static final String PAYLOAD_NAME
```
    See Also:
    
    Constant Field Values
  - PRIORITY_NORMAL
```
static final int PRIORITY_NORMAL
```
    Default (normal) event delivery priority value.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getEventName
```
QName getEventName()
```
    The name of the Event. This will correspond to the name given in the event's EDL.
    
    Returns:
    
    The name of the event
  - getProperty
```
Object getProperty(String name)
```
    Get a single value for a header. If the header has multiple values, the result of this method is a random one.
    
    Parameters:
    
    name - - property name
    
    Returns:
    
    A value for the given header name or null if there are no values for this header
  - getProperties
```
Map<String,Object> getProperties()
```
    Get all the properties of this event.
    
    Returns:
    
    all the properties of this event.
  - getBody
```
Element getBody()
```
    Get the XML body of the event. Since the body is optional, this value may be null.
    
    Returns:
    
    The body payload as DOM element.
  - getBodyAsText
```
String getBodyAsText()
```
    Get the payload body as serialized XML text. Since the body is optional, this value may be null.
    
    Returns:
    
    The body payload as text.
  - getAsDoc
```
Document getAsDoc()
```
    Return the event as a DOM document.
    
    Returns:
    
    the event as a DOM document.

Interface BusinessEvent

Field Summary

Method Summary

Field Detail

NAME

EVENT_ID

PARENT_ID

PRIORITY

PUBLISHED_TIME

OWNER

SOURCE

CONTEXT

MODE

NAMESPACE

LOCAL_NAME

TIME_TO_LIVE

PERSISTENT

DURABLE

EDN_BUS_PUBLISHED

PROPERTY_ECID

PROPERTY_PARENT_COMPONENT_INSTANCE_ID

PROPERTY_CONVERSATION_ID

PROPERTY_COMPOSITE_INSTANCE_ID

COMPOSITE_INSTANCE_CREATED_TIME

TRACKING_IS_EDN_EVENT

PAYLOAD_NAME

PRIORITY_NORMAL

Method Detail

getEventName

getProperty

getProperties

getBody

getBodyAsText

getAsDoc