Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.wlai.common
Interface IEventDescriptor

All Superinterfaces:
  IDescriptor, IPropertiedDescriptor, Serializable

public interface IEventDescriptor
extends IPropertiedDescriptor, Serializable

Describes the metadata for a class of events, including the schema that describes the content of the event payload at runtime, and root element name within that schema. This descriptor can also contain adapter-specific property values. These values are opaque to WLAI, and are only for use by the adapter itself. Because this interface extends Serializable, all implementations of this class should be Serializable.

Method Summary
`String` | `getRootElementName()` Get the name of the root element for the event payload (XML) for events of this type that are received at runtime.
`String` | `getSchemaNameString()` Get the name of the schema for the event type represented by this descriptor.
`boolean` | `ownsSchema()`
`void` | `setOwnsSchemaFlag(boolean bOwns)` Sets a flag that indicates if this event owns the schema it references; this flag is true by default.
`void` | `setRootElementName(String name)` Set the name of the root element for the event payload (XML) for events of this type that are received at runtime.
`void` | `setSchemaNameString(String name)` Set the name of the schema for the event type represented by this descriptor.

Methods inherited from interface com.bea.wlai.common.IPropertiedDescriptor
`addProperty, getProperty, listPropertyNames, removeProperty`

Methods inherited from interface com.bea.wlai.common.IDescriptor
`fromXML, fromXML, fromXML, getDescription, getName, isReadOnly, makeReadOnly, setDescription, setName, toXML, toXML, toXML`

Method Detail

### setOwnsSchemaFlag

    public void setOwnsSchemaFlag(boolean bOwns)

  Sets a flag that indicates if this event owns the schema it references; this flag is true by default. Setting the flag to false indicates that the schema is referenced by other components and not solely owned by this event

### ownsSchema

    public boolean ownsSchema()

  Returns:
    true if this event owns the schema it references, false otherwise.

### getSchemaNameString

    public String getSchemaNameString()

  Get the name of the schema for the event type represented by this descriptor. The schema defines the structure and content of the event payload for events of this type that are received at runtime.

  Returns:
    The name of the schema for the event type for this descriptor.

### setSchemaNameString

    public void setSchemaNameString(String name)

  Set the name of the schema for the event type represented by this descriptor. The schema defines the structure and content of the event payload for events of this type that are received at runtime.

  Parameters:
    `name` - The name of the schema for the event type for this descriptor.

### getRootElementName

    public String getRootElementName()

  Get the name of the root element for the event payload (XML) for events of this type that are received at runtime.

  Returns:
    The name of the root element present in the event payload (XML) for events of this type.

### setRootElementName

    public void setRootElementName(String name)

  Set the name of the root element for the event payload (XML) for events of this type that are received at runtime.

  Parameters:
    `name` - The name of the root element present in the event payload (XML) for events of this type.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD