oracle.ifs.common

Class RetainedEvent

java.lang.Object

oracle.ifs.common.RetainedEvent

Direct Known Subclasses:

ExecutedActionRetainedEvent, ManualTextIndexingRetainedEvent, MiscOperations.TradeAlertRetainedEvent

public abstract class RetainedEvent
extends Object

A RetainedEvent contains information used to store and retrieve messages used as notifications to and from external systems or processes, or for asynchronous processing in an agent.

Version:

1.0

Author:

Dave Long

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected AttributeValue[]	m_Values The set of values for this RetainedEvent.

Constructor Summary

Constructors

Constructor and Description
RetainedEvent()

Method Summary

Modifier and Type	Method and Description
abstract RetainedEvent[]	constructArray(int size) Construct an array of the specified size and of the correct type
abstract RetainedEvent	constructInstance() Construct a new unpopulated instance, of the correct type.
void	createDatabaseObjects(LibrarySessionInterface session) Create the database objects associated with the retained event type.
void	delete(LibrarySessionInterface session) Delete a RetainedEvent.
void	dropDatabaseObjects(LibrarySessionInterface session) Drop the database objects associated with the retained event type.
String	getCreateSequenceStatementSql() Get the SQL statement string used to create the Retained event sequence
String	getCreateTableStatementSql() Get the SQL statement string used to create the Retained event table
String	getDeleteStatementKey() Get the statement key used for a delete
String	getDeleteStatementSql() get the SQL statement string used for a delete
String	getDropSequenceStatementSql() Get the SQL statement string used to drop the Retained event sequence
String	getDropTableStatementSql() Get the SQL statement string used to drop the Retained event table
Long	getId() Gets the id of the event
String	getInsertStatementKey() Get the statement key used for an insert
String	getInsertStatementSql() get the SQL statement string used for an insert
protected abstract RetainedEventDescriptor[]	getRetainedEventDescriptors() Get name/type descriptors that define the payload for this retained event.
String	getSelectStatementKey() get the statement key used for a select
String	getSelectStatementSql() get the SQL statement string used for a select
abstract String	getSequenceName() Get sequence name used by this specific type of retained event.
abstract String	getTableName() Get table name used to store the specific type of retained event.
AttributeValue[]	getValues() Gets the column values for this instance
void	insert(LibrarySessionInterface session) Insert a RetainedEvent.
void	process(LibrarySession session) Process this retained event.
int	processAll(LibrarySession session, int batchSize, boolean purgeOnly) Process all pending RetainedEvents.
RetainedEvent[]	select(LibrarySessionInterface session, int maxItems) Select a set of RetainedEvents.
protected void	setValues(AttributeValue[] values) Set the values for this instance.
String	toString() Convert to String representation.

Methods inherited from class java.lang.Object

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

Field Detail

m_Values

protected AttributeValue[] m_Values

The set of values for this RetainedEvent.

Set when a RetainedEvent is constructed with the payload, and when constructed as a result of selecting the RetainedEvent from the database.

(Unpublished)

Constructor Detail

RetainedEvent

public RetainedEvent()

Method Detail

getId

public final Long getId()

Gets the id of the event

Returns:

the id

(Published)

toString

public String toString()

Convert to String representation.

Overrides:

toString in class Object

Returns:

the String representation of this event

(Published)

getValues

public final AttributeValue[] getValues()
                                 throws IfsException

Gets the column values for this instance

Returns:

the values

Throws:

IfsException

(Published)

getTableName

public abstract String getTableName()

Get table name used to store the specific type of retained event.

Returns:

the table name

(Published)

getSequenceName

public abstract String getSequenceName()

Get sequence name used by this specific type of retained event.

Returns:

the sequence name

(Published)

getRetainedEventDescriptors

protected abstract RetainedEventDescriptor[] getRetainedEventDescriptors()

Get name/type descriptors that define the payload for this retained event.

Returns:

the name/type descriptors

(Published)

constructInstance

public abstract RetainedEvent constructInstance()

Construct a new unpopulated instance, of the correct type.

Returns:

the new instance

(Published)

constructArray

public abstract RetainedEvent[] constructArray(int size)

Construct an array of the specified size and of the correct type

Parameters:

size - the array size

Returns:

the new array

(Published)

process

public void process(LibrarySession session)
             throws IfsException

Process this retained event.

It is assumed that a transaction process has been established by the caller. Also, the caller will ensure that the event is properly disposed aftert this method completes.

Parameters:

session - bean-side session context

Throws:

IfsException - if the operation fails

setValues

protected void setValues(AttributeValue[] values)
                  throws IfsException

Set the values for this instance.

This is invoked either when a RetainedEvent is constructed with the entire event payload specified (when posting the event), or when an event is selected from the database.

Parameters:

values - the event payload, ordered according to the column order established by the subclass

Throws:

IfsException - if operation fails.

(Published)

createDatabaseObjects

public void createDatabaseObjects(LibrarySessionInterface session)
                           throws IfsException

Create the database objects associated with the retained event type.

The session must be in admin mode to perform this operation. If the session context specified is a LibrarySession, the request is sent server side.

Parameters:

session - session context

Throws:

IfsException - if operation fails.

(Unpublished)

dropDatabaseObjects

public void dropDatabaseObjects(LibrarySessionInterface session)
                         throws IfsException

Drop the database objects associated with the retained event type.

The session must be in admin mode to perform this operation. If the session context specified is a LibrarySession, the request is sent server side.

Parameters:

session - session context

Throws:

IfsException - if operation fails.

(Unpublished)

insert

public void insert(LibrarySessionInterface session)
            throws IfsException

Insert a RetainedEvent.

If the session context specified is a LibrarySession, the request is sent server side.

Parameters:

session - session context

Throws:

IfsException - if operation fails.

(Unpublished)

delete

public void delete(LibrarySessionInterface session)
            throws IfsException

Delete a RetainedEvent.

If the session context specified is a LibrarySession, the request is sent server side.

Parameters:

session - session context

Throws:

IfsException - if operation fails.

(Unpublished)

select

public RetainedEvent[] select(LibrarySessionInterface session,
                              int maxItems)
                       throws IfsException

Select a set of RetainedEvents.

If the session context specified is a LibrarySession, the request is sent server side.

Parameters:

session - session context

maxItems - max number of items to select

Returns:

the set of RetainedEvents

Throws:

IfsException - if operation fails.

(Unpublished)

processAll

public int processAll(LibrarySession session,
                      int batchSize,
                      boolean purgeOnly)
               throws IfsException

Process all pending RetainedEvents.

This operation only runs bean-side.

Parameters:

session - session context

Throws:

IfsException - if operation fails.

(Unpublished)

getInsertStatementKey

public String getInsertStatementKey()

Get the statement key used for an insert

Returns:

statement key

(Unpublished)

getSelectStatementKey

public String getSelectStatementKey()

get the statement key used for a select

Returns:

statement key

(Unpublished)

getDeleteStatementKey

public String getDeleteStatementKey()

Get the statement key used for a delete

Returns:

statement key

(Unpublished)

getInsertStatementSql

public String getInsertStatementSql()

get the SQL statement string used for an insert

Returns:

statement string

(Unpublished)

getDeleteStatementSql

public String getDeleteStatementSql()

get the SQL statement string used for a delete

Returns:

statement string

(Unpublished)

getSelectStatementSql

public String getSelectStatementSql()

get the SQL statement string used for a select

Returns:

statement string

(Unpublished)

getCreateTableStatementSql

public String getCreateTableStatementSql()
                                  throws IfsException

Get the SQL statement string used to create the Retained event table

Returns:

statement string

Throws:

IfsException - if operation fails.

(Published)

getCreateSequenceStatementSql

public String getCreateSequenceStatementSql()

Get the SQL statement string used to create the Retained event sequence

Returns:

statement string

(Published)

getDropTableStatementSql

public String getDropTableStatementSql()

Get the SQL statement string used to drop the Retained event table

Returns:

statement string

(Published)

getDropSequenceStatementSql

public String getDropSequenceStatementSql()

Get the SQL statement string used to drop the Retained event sequence

Returns:

statement string

(Published)