oracle.jbo.server
Class EventPayload

java.lang.Object
  oracle.jbo.server.EventPayload

All Implemented Interfaces:

DefPersistable, PersistentDefinition

public class EventPayload
extends java.lang.Object
implements DefPersistable

Field Summary

Fields inherited from interface oracle.jbo.mom.xml.DefPersistable

XML_STATEMENT

Constructor Summary

EventPayload()

Method Summary

java.lang.Object	clone()
java.lang.String	getDefXMLElementTag()
java.lang.String	getDefXMLNameSpace()
java.lang.String	getFullName() This method returns the Persistence reference of the object.
java.lang.String	getName() Return the name of the payload (null).
int	getNumPayloadItems() Gets the number of actual payload items for the event definition.
DefPersistable	getOrigObject()
java.util.Iterator	getPayloadItems() Returns the list of payload items for the event definition.
java.lang.String	getXMLElementTag() Returns a piece of static info for the type of object this is invoked upon.
boolean	isDirty() This method returns if an Object is modified from last save/load
boolean	isNew() This method returns if this object is previously persisted.
void	setDirty(boolean b) This method marks the Object dirty
void	setNew(boolean b) This method marks the as previously persisted.
void	setOrigObject(DefPersistable oldObj)
void	writeChildren(DefWriter jos) Writes the Object's children to the Persistent storage
void	writeContents(DefWriter jos) Objects should write their persistence output in this method
void	writeObject(DefWriter jos) Objects should write their persistence output in this method

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventPayload

public EventPayload()

Method Detail

getName

public java.lang.String getName()

Return the name of the payload (null).

Returns:

the name of the payload in the event definition.

getPayloadItems

public java.util.Iterator getPayloadItems()

Returns the list of payload items for the event definition. A payload item specifies an attribute that is to be part of the payload and contains parameters that indicate how it is to be processed when constructing the actual payload when raising an event.

Returns:

the list of payload items for the event definition.

getNumPayloadItems

public int getNumPayloadItems()

Gets the number of actual payload items for the event definition. If the event definition references a named payload definition, it will be the number of payload items defined in that definition. Otherwise, it will be the number of payload items defined in the event definitions inline payload.

Returns:

the number of payload items for the event definition.

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

isDirty

public boolean isDirty()

Description copied from interface: DefPersistable

This method returns if an Object is modified from last save/load

Specified by:

isDirty in interface DefPersistable

Returns:

Returns true if the Object is dirty. Returns false otherwise.

setOrigObject

public void setOrigObject(DefPersistable oldObj)

Specified by:

setOrigObject in interface DefPersistable

getOrigObject

public DefPersistable getOrigObject()

Specified by:

getOrigObject in interface DefPersistable

getFullName

public java.lang.String getFullName()

Description copied from interface: DefPersistable

This method returns the Persistence reference of the object. The Persistence Reference is uniquely identifiable fully qualified name of the object.

Specified by:

getFullName in interface DefPersistable

Returns:

the Persistence Reference of the object

isNew

public boolean isNew()

Description copied from interface: DefPersistable

This method returns if this object is previously persisted.

Specified by:

isNew in interface DefPersistable

Returns:

true if the Object is previously persisted. Returns false otherwise.

setNew

public void setNew(boolean b)

Description copied from interface: DefPersistable

This method marks the as previously persisted. By default all objects are new objects. When the object is persisted first time, that object is marked as 'not new' object

Specified by:

setNew in interface DefPersistable

Parameters:

b - If true the Object is marked as new object.

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

getXMLElementTag

public java.lang.String getXMLElementTag()

Description copied from interface: PersistentDefinition

Returns a piece of static info for the type of object this is invoked upon. Examples are PreparedStatements for insert, update, delete, and String containing a base the select statement for retrieving instances of this type through the SQLInputStream

Specified by:

getXMLElementTag in interface PersistentDefinition

Returns:

returns the Statement required to store in Persitent Storage. Incase of XML, it just returns the String. In the case of SQL a JDBC PreparedStatement is returned.

setDirty

public void setDirty(boolean b)

Description copied from interface: DefPersistable

This method marks the Object dirty

Specified by:

setDirty in interface DefPersistable

Parameters:

b - If true the Object is marked Dirty.

writeChildren

public void writeChildren(DefWriter jos)

Description copied from interface: PersistentDefinition

Writes the Object's children to the Persistent storage

Specified by:

writeChildren in interface PersistentDefinition

Parameters:

jos - the Output storage for persistence

writeContents

public void writeContents(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeContents in interface PersistentDefinition

Parameters:

jos - the Output storage for persistence

writeObject

public void writeObject(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeObject in interface PersistentDefinition

Parameters:

jos - the Output storage for persistence