oracle.ifs.core.activity

Class ActionFactory

java.lang.Object

oracle.ifs.core.activity.ActionFactory

Direct Known Subclasses:

ActionAdapter

public abstract class ActionFactory
extends Object

An ActionFactory constructs Action instances repesenting both pre- and post- execution states.

Constructor Summary

Constructors

Constructor and Description
ActionFactory()

Method Summary

Modifier and Type	Method and Description
static AuditEventTypeDefinition	constructActivityEventTypeDefinition(String opTypeKey, int opCode) Constructs an AuditEventTypeDefinition for an AuditEvent to be used for posting activity on an ActivityRecord.
abstract Action	constructExecutedAction(AuditEvent event) Construct an instance reflecting a previously executed Action.
abstract Action	constructPendingAction() Construct an instance of an Action that is not yet executed.
ActionSpecification	getActionSpecification() Gets the ActionSpecification associated with this instance.
Long	getActionSpecificationId() Gets the ActionSpecification ID associated with this instance.
abstract AuditEventTypeDefinition[]	getAuditEventTypeDefinitions() Gets the set of AuditEventTypeDefinitions for events that can be created by this Action associated with this type of Action.
AttributeValueTable	getPropertyTable() Gets the AttributeValueTable representing the set of Properties defined for the ActionSpecification associated with this instance.
LibrarySession	getSession() Gets the session context associated with this instance.
void	initialize(ActionSpecification spec) Initialize this instance.
boolean	isInitialized() Returns true is this factory instance has been properly initialized.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionFactory

public ActionFactory()

Method Detail

initialize

public void initialize(ActionSpecification spec)
                throws IfsException

Initialize this instance.

Called immediately after construction (via the default constructor) via reflection within ActionSpecification.

Parameters:

spec - The ActionSpecification for a given implementation.

Throws:

IfsException - if the operation fails.

getSession

public LibrarySession getSession()

Gets the session context associated with this instance.

Returns:

the session context

getActionSpecification

public ActionSpecification getActionSpecification()

Gets the ActionSpecification associated with this instance.

Returns:

the ActionSpecification

getActionSpecificationId

public Long getActionSpecificationId()

Gets the ActionSpecification ID associated with this instance.

Returns:

the ActionSpecification ID

getPropertyTable

public AttributeValueTable getPropertyTable()

Gets the AttributeValueTable representing the set of Properties defined for the ActionSpecification associated with this instance.

Returns:

the ActionSpecification property table

isInitialized

public boolean isInitialized()

Returns true is this factory instance has been properly initialized.

Returns:

true if initialized; false otherwise

constructPendingAction

public abstract Action constructPendingAction()
                                       throws IfsException

Construct an instance of an Action that is not yet executed.

Returns:

The Action instance, ready to be setup for subsequent execution

Throws:

IfsException - if the operation fails.

constructExecutedAction

public abstract Action constructExecutedAction(AuditEvent event)
                                        throws IfsException

Construct an instance reflecting a previously executed Action.

Parameters:

event - The event that was posted as part of the previously executed Action.

Returns:

The Action instance, reflecting the previous execution

Throws:

IfsException - if the operation fails.

getAuditEventTypeDefinitions

public abstract AuditEventTypeDefinition[] getAuditEventTypeDefinitions()

Gets the set of AuditEventTypeDefinitions for events that can be created by this Action associated with this type of Action.

Returns:

the definitions for event types used by this instance

constructActivityEventTypeDefinition

public static AuditEventTypeDefinition constructActivityEventTypeDefinition(String opTypeKey,
                                                                            int opCode)

Constructs an AuditEventTypeDefinition for an AuditEvent to be used for posting activity on an ActivityRecord.

Parameters:

opTypeKey - the String operation type key (e.g. "ACTIVITYRECORD_MESSAGE_ADDED")

opCode - the enumerated int representing the code for the operation (e.g. 1009 for "MESSAGE_ADDED")

Returns:

the constructed AuditEventTypeDefinition