Top Description Fields Constructors Methods
org.eclipse.persistence.sessions

public Class SessionEvent

extends EventObject
Class Inheritance
Imports
java.util.*, org.eclipse.persistence.queries.*

Purpose: Encapsulate the information provided with session events. This is used as the argument to any event raised by the session. To register for events notification an event listener must be registered with the session.

See Also
SessionEventManager#addListener(SessionEventListener), Session#getEventManager(), SessionEventListener

Field Summary

Modifier and TypeField and Description
protected Call
call

Some events may have a call associated with them (pre/postExecuteCall).

protected int
eventCode

The code of the event being raised.

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
protected Hashtable<K, V>
properties

Additional properties may be added.

protected DatabaseQuery
query

Some events may have a query associated with them (pre/postExecuteQuery).

protected Object
result

Some events may have a result associated with them (pre/postExecuteQuery).

protected Session
session

The session or unit of work raising the event.

Inherited from java.util.EventObject:
source

Constructor Summary

AccessConstructor and Description
public
SessionEvent(int eventCode, Session session)

INTERNAL: Create the event.

Method Summary

Modifier and TypeMethod and Description
public Call
getCall()

PUBLIC: Some events may have a call associated with them (pre/postExecuteCall).

public int
getEventCode()

PUBLIC: The code of the session event being raised.

public Hashtable<K, V>
getProperties()

PUBLIC: Additional properties may be added to the event.

public Object
getProperty(String name)

PUBLIC: Additional properties may be added to the event.

public DatabaseQuery
getQuery()

PUBLIC: Some events may have a query associated with them (pre/postExecuteQuery).

public Object
getResult()

PUBLIC: Some events may have a result associated with them (pre/postExecuteQuery).

public Session
getSession()

PUBLIC: The session in which the event is raised.

public void
setCall(Call call)

INTERNAL: Some events may have a call associated with them (pre/postExecuteCall).

public void
setEventCode(int eventCode)

INTERNAL: The code of the session event being raised.

public void
setProperties(Hashtable<K, V> properties)

INTERNAL: Additional properties may be added to the event.

public void
setProperty(String name, Object value)

INTERNAL: Additional properties may be added to the event.

public void
setQuery(DatabaseQuery query)

INTERNAL: Some events may have a query associated with them (pre/postExecuteQuery).

public void
setResult(Object result)

INTERNAL: Some events may have a result associated with them (pre/postExecuteQuery).

public void
setSession(Session session)

INTERNAL: The session in which the event is raised.

Inherited from java.util.EventObject:
getSourcetoString

Field Detail

callback to summary
protected Call call

Some events may have a call associated with them (pre/postExecuteCall).

eventCodeback to summary
protected int eventCode

The code of the event being raised. This is an integer constant value as defined below.

MissingDescriptorback to summary
public static final int MissingDescriptor
MoreRowsDetectedback to summary
public static final int MoreRowsDetected
NoRowsModifiedback to summary
public static final int NoRowsModified
OutputParametersDetectedback to summary
public static final int OutputParametersDetected
PostAcquireClientSessionback to summary
public static final int PostAcquireClientSession
PostAcquireConnectionback to summary
public static final int PostAcquireConnection
PostAcquireExclusiveConnectionback to summary
public static final int PostAcquireExclusiveConnection
PostAcquireUnitOfWorkback to summary
public static final int PostAcquireUnitOfWork
PostBeginTransactionback to summary
public static final int PostBeginTransaction
PostCalculateUnitOfWorkChangeSetback to summary
public static final int PostCalculateUnitOfWorkChangeSet
PostCommitTransactionback to summary
public static final int PostCommitTransaction
PostCommitUnitOfWorkback to summary
public static final int PostCommitUnitOfWork
PostConnectback to summary
public static final int PostConnect
PostDistributedMergeUnitOfWorkChangeSetback to summary
public static final int PostDistributedMergeUnitOfWorkChangeSet
PostExecuteCallback to summary
public static final int PostExecuteCall
PostExecuteQueryback to summary
public static final int PostExecuteQuery
PostLoginback to summary
public static final int PostLogin
PostLogoutback to summary
public static final int PostLogout
PostMergeUnitOfWorkChangeSetback to summary
public static final int PostMergeUnitOfWorkChangeSet
PostReleaseClientSessionback to summary
public static final int PostReleaseClientSession
PostReleaseUnitOfWorkback to summary
public static final int PostReleaseUnitOfWork
PostResumeUnitOfWorkback to summary
public static final int PostResumeUnitOfWork
PostRollbackTransactionback to summary
public static final int PostRollbackTransaction
PreBeginTransactionback to summary
public static final int PreBeginTransaction
PreCalculateUnitOfWorkChangeSetback to summary
public static final int PreCalculateUnitOfWorkChangeSet
PreCommitTransactionback to summary
public static final int PreCommitTransaction
PreCommitUnitOfWorkback to summary
public static final int PreCommitUnitOfWork
PreDistributedMergeUnitOfWorkChangeSetback to summary
public static final int PreDistributedMergeUnitOfWorkChangeSet
PreExecuteCallback to summary
public static final int PreExecuteCall
PreExecuteQueryback to summary
public static final int PreExecuteQuery
PreLoginback to summary
public static final int PreLogin
PreLogoutback to summary
public static final int PreLogout
PreMergeUnitOfWorkChangeSetback to summary
public static final int PreMergeUnitOfWorkChangeSet
PrepareUnitOfWorkback to summary
public static final int PrepareUnitOfWork
PreReleaseClientSessionback to summary
public static final int PreReleaseClientSession
PreReleaseConnectionback to summary
public static final int PreReleaseConnection
PreReleaseExclusiveConnectionback to summary
public static final int PreReleaseExclusiveConnection
PreReleaseUnitOfWorkback to summary
public static final int PreReleaseUnitOfWork
PreRollbackTransactionback to summary
public static final int PreRollbackTransaction
propertiesback to summary
protected Hashtable<K, V> properties

Additional properties may be added.

queryback to summary
protected DatabaseQuery query

Some events may have a query associated with them (pre/postExecuteQuery).

resultback to summary
protected Object result

Some events may have a result associated with them (pre/postExecuteQuery).

sessionback to summary
protected Session session

The session or unit of work raising the event.

Constructor Detail

SessionEventback to summary
public SessionEvent(int eventCode, Session session)

INTERNAL: Create the event.

Method Detail

getCallback to summary
public Call getCall()

PUBLIC: Some events may have a call associated with them (pre/postExecuteCall).

getEventCodeback to summary
public int getEventCode()

PUBLIC: The code of the session event being raised. This is an integer constant value from this class.

getPropertiesback to summary
public Hashtable<K, V> getProperties()

PUBLIC: Additional properties may be added to the event.

getPropertyback to summary
public Object getProperty(String name)

PUBLIC: Additional properties may be added to the event.

getQueryback to summary
public DatabaseQuery getQuery()

PUBLIC: Some events may have a query associated with them (pre/postExecuteQuery).

getResultback to summary
public Object getResult()

PUBLIC: Some events may have a result associated with them (pre/postExecuteQuery).

getSessionback to summary
public Session getSession()

PUBLIC: The session in which the event is raised.

setCallback to summary
public void setCall(Call call)

INTERNAL: Some events may have a call associated with them (pre/postExecuteCall).

setEventCodeback to summary
public void setEventCode(int eventCode)

INTERNAL: The code of the session event being raised. This is an integer constant value from this class.

setPropertiesback to summary
public void setProperties(Hashtable<K, V> properties)

INTERNAL: Additional properties may be added to the event.

setPropertyback to summary
public void setProperty(String name, Object value)

INTERNAL: Additional properties may be added to the event.

setQueryback to summary
public void setQuery(DatabaseQuery query)

INTERNAL: Some events may have a query associated with them (pre/postExecuteQuery).

setResultback to summary
public void setResult(Object result)

INTERNAL: Some events may have a result associated with them (pre/postExecuteQuery).

setSessionback to summary
public void setSession(Session session)

INTERNAL: The session in which the event is raised.