oracle.ifs.core.activity

Class ExecutedActionRetainedEvent

java.lang.Object

oracle.ifs.common.RetainedEvent

oracle.ifs.core.activity.ExecutedActionRetainedEvent

All Implemented Interfaces:

Serializable

public class ExecutedActionRetainedEvent
extends RetainedEvent
implements Serializable

A ExecutedActionRetainedEvent is a type of RetainedEvent used to notify an agent that an Action has been executed.

Author:

Dave Long

See Also:

Serialized Form

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVITYRECORDID_COL_INDEX Column position (zero-based) for the ActivityRecord id
static int	AUDITEVENTID_COL_INDEX Column position (zero-based) for the AuditEvent ID
static int	COL_LENGTH Number of columns used to define this retained event

Fields inherited from class oracle.ifs.common.RetainedEvent

m_Values

Constructor Summary

Constructors

Constructor and Description
ExecutedActionRetainedEvent() Construct an empty ExecutedActionRetainedEvent.
ExecutedActionRetainedEvent(ActivityRecord ar, long eventId) Construct a ExecutedActionRetainedEvent that reflects an executed Action.

Method Summary

Modifier and Type	Method and Description
RetainedEvent[]	constructArray(int size) Construct an array of the specified size.
RetainedEvent	constructInstance() Construct a new unpopulated instance, of the correct type.
ActivityRecord	getActivityRecord(LibrarySession session) Returns the ActivityRecord that was the target of the executed Action.
long	getAuditEventId() Gets the AuditEvent ID that corresponds to the Action that was executed.
protected RetainedEventDescriptor[]	getRetainedEventDescriptors() Get name/type descriptors that define the payload for this retained event.
String	getSequenceName() Get sequence name used by this specific type of retained event.
String	getTableName() Get table name used to store the specific type of retained event.
void	process(LibrarySession session) Process this retained event.

Methods inherited from class oracle.ifs.common.RetainedEvent

createDatabaseObjects, delete, dropDatabaseObjects, getCreateSequenceStatementSql, getCreateTableStatementSql, getDeleteStatementKey, getDeleteStatementSql, getDropSequenceStatementSql, getDropTableStatementSql, getId, getInsertStatementKey, getInsertStatementSql, getSelectStatementKey, getSelectStatementSql, getValues, insert, processAll, select, setValues, toString

Methods inherited from class java.lang.Object

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

Field Detail

COL_LENGTH

public static final int COL_LENGTH

Number of columns used to define this retained event

See Also:

Constant Field Values

ACTIVITYRECORDID_COL_INDEX

public static final int ACTIVITYRECORDID_COL_INDEX

Column position (zero-based) for the ActivityRecord id

See Also:

Constant Field Values

AUDITEVENTID_COL_INDEX

public static final int AUDITEVENTID_COL_INDEX

Column position (zero-based) for the AuditEvent ID

See Also:

Constant Field Values

Constructor Detail

ExecutedActionRetainedEvent

public ExecutedActionRetainedEvent()

Construct an empty ExecutedActionRetainedEvent.

This variant is used when an instance is needed to select other instances of ExecutedActionRetainedEvent from the database.

ExecutedActionRetainedEvent

public ExecutedActionRetainedEvent(ActivityRecord ar,
                                   long eventId)
                            throws IfsException

Construct a ExecutedActionRetainedEvent that reflects an executed Action.

Parameters:

ar - the ActivityRecord for which the Action was executed

eventId - the ID of the AuditEvent that corresponds to the Action that was executed

Throws:

IfsException - if the operation fails

Method Detail

getTableName

public final String getTableName()

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

Specified by:

getTableName in class RetainedEvent

Returns:

the table name

(Published)

getSequenceName

public String getSequenceName()

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

Specified by:

getSequenceName in class RetainedEvent

Returns:

the sequence name

(Published)

getRetainedEventDescriptors

protected RetainedEventDescriptor[] getRetainedEventDescriptors()

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

Specified by:

getRetainedEventDescriptors in class RetainedEvent

Returns:

the name/type descriptors

(Published)

constructInstance

public RetainedEvent constructInstance()

Construct a new unpopulated instance, of the correct type.

Specified by:

constructInstance in class RetainedEvent

Returns:

the new instance

(Published)

constructArray

public RetainedEvent[] constructArray(int size)

Construct an array of the specified size.

Specified by:

constructArray in class RetainedEvent

Parameters:

size - the array size

Returns:

the new array

(Published)

getActivityRecord

public ActivityRecord getActivityRecord(LibrarySession session)
                                 throws IfsException

Returns the ActivityRecord that was the target of the executed Action.

Parameters:

session - the session context

Returns:

the ActivityRecord

Throws:

IfsException - if the operation fails

getAuditEventId

public long getAuditEventId()
                     throws IfsException

Gets the AuditEvent ID that corresponds to the Action that was executed.

Returns:

the AuditEvent ID for the executed Action

Throws:

IfsException - if the operation fails

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.

Overrides:

process in class RetainedEvent

Parameters:

session - session context

Throws:

IfsException - if the operation fails