oracle.ifs.beans

Class ActionSpecification

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.beans.ActionSpecification

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieActionSpecification

public class ActionSpecification
extends TieSystemObject

An ActionSpecification is used to construct a particular instance of Action, using properties defined on the instance.

Author:

Dave Long

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIONFACTORYCLASSNAME_ATTRIBUTE The name of the attribute that holds fully-qualified class name of the ActionFactory class associated with the instance.
static String	ACTIONSPECIFICATION_HIERARCHY_TABLENAME The table name which contains the ActionSpecification hierarchy.
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	DESCRIPTION_ATTRIBUTE The name of the attribute that holds the description of this ActionSpecification.
static String	NAME_ATTRIBUTE The name of the attribute that holds the name of this ActionSpecification.
static String	SUPERACTIONSPECIFICATION_ATTRIBUTE The ActionSpecification whose ActionFactory class is the designated superclass for this instance.

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActionSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a ActionSpecification object.

Method Summary

Modifier and Type	Method and Description
void	clearCachedActionFactory() Clears the cached ActionFactory.
static ActionSpecification[]	findAll(LibrarySession session) Returns the set of defined ActionSpecifications.
static ActionSpecification	findByName(LibrarySession session, String name) Returns the a ActionSpecification matching the specified name.
ActionFactory	getActionFactory() Gets the ActionFactory instance implementation corresponding to the ActionClassName, that is used as a factory for subsequent Action instances (pre and post execution).
String	getActionFactoryClassName() Gets the fully-qualified class name of the ActionFactory class.
AuditEventTypeDefinition[]	getAuditEventTypeDefinitions() Gets the set of AuditEventTypeDefinitions for events that can be created by this action.
String	getDescription() Gets the description of this ActionSpecification.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySession session) Returns the LibraryObjectLookupCache used by find ActionSpecification instances by name.
AttributeValueTable	getPropertyTable() Gets the AttributeValueTable representing the set of Properties defined for this instance.
ActionSpecification	getSuperActionSpecification() Gets the ActionSpecification whose ActionFactory class is the designated superclass for this instance.
void	handleEvent(IfsEvent event) Handles the specified event.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a SystemObject.
protected void	postUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the update of a SystemObject.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
void	refresh() Refresh the event registratons from this instance.
protected void	registerAuditEventTypes() Register all events defined by this instance's ActionFactory that are not already registered.

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

(Published)

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of the attribute that holds the name of this ActionSpecification. (String[700])

See Also:

Constant Field Values

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

The name of the attribute that holds the description of this ActionSpecification. (String[2000])

See Also:

Constant Field Values

ACTIONFACTORYCLASSNAME_ATTRIBUTE

public static final String ACTIONFACTORYCLASSNAME_ATTRIBUTE

The name of the attribute that holds fully-qualified class name of the ActionFactory class associated with the instance. (String[700])

See Also:

Constant Field Values

SUPERACTIONSPECIFICATION_ATTRIBUTE

public static final String SUPERACTIONSPECIFICATION_ATTRIBUTE

The ActionSpecification whose ActionFactory class is the designated superclass for this instance.

See Also:

Constant Field Values

ACTIONSPECIFICATION_HIERARCHY_TABLENAME

public static final String ACTIONSPECIFICATION_HIERARCHY_TABLENAME

The table name which contains the ActionSpecification hierarchy.

See Also:

Constant Field Values

Constructor Detail

ActionSpecification

protected ActionSpecification(LibrarySession session,
                              Long id,
                              Long classId,
                              S_LibraryObjectData data)
                       throws IfsException

Construct a ActionSpecification object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Description copied from class: LibraryObject

Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true if the object has a NAME attribute.

Throws:

IfsException - if operation fails.

getDescription

public String getDescription()
                      throws IfsException

Gets the description of this ActionSpecification.

Returns:

the object description

Throws:

IfsException - if operation fails

getActionFactoryClassName

public String getActionFactoryClassName()
                                 throws IfsException

Gets the fully-qualified class name of the ActionFactory class.

Returns:

the class name of the ActionFactory

Throws:

IfsException - if operation fails

getSuperActionSpecification

public ActionSpecification getSuperActionSpecification()
                                                throws IfsException

Gets the ActionSpecification whose ActionFactory class is the designated superclass for this instance.

Returns:

the super ActionSpecification

Throws:

IfsException - if operation fails

getPropertyTable

public AttributeValueTable getPropertyTable()
                                     throws IfsException

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

Returns:

the AttributeValueTable representing the properties

Throws:

IfsException - if operation fails

getAuditEventTypeDefinitions

public AuditEventTypeDefinition[] getAuditEventTypeDefinitions()
                                                        throws IfsException

Gets the set of AuditEventTypeDefinitions for events that can be created by this action.

Returns:

the definitions for event types registered by this instance

Throws:

IfsException - if the operation fails.

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find ActionSpecification instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

public static ActionSpecification[] findAll(LibrarySession session)
                                     throws IfsException

Returns the set of defined ActionSpecifications.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of ActionSpecifications; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

public static ActionSpecification findByName(LibrarySession session,
                                             String name)
                                      throws IfsException

Returns the a ActionSpecification matching the specified name.

ActionSpecification names are case sensitive, so this operations requires an exact match with respect to case.

Parameters:

session - the session context

name - the ActionSpecification name

Returns:

the ActionSpecification matching the specified name; or null if there exists no matching ActionSpecification

Throws:

IfsException - if the operation fails.

refresh

public void refresh()
             throws IfsException

Refresh the event registratons from this instance.

Throws:

IfsException - if the operation fails.

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Description copied from class: SystemObject

Extensibility point to perform actions after the creation of a SystemObject.

This assumes that a transaction context has already been established.

Overrides:

postCreate in class SystemObject

Parameters:

lodef - object definition that was used to create the object

Throws:

IfsException - if operation fails

postUpdate

protected void postUpdate(LibraryObjectDefinition lodef)
                   throws IfsException

Description copied from class: SystemObject

Extensibility point to perform actions after the update of a SystemObject.

Create any categories that are specified in the definition.

Overrides:

postUpdate in class SystemObject

Parameters:

lodef - object definition used to define how the target object was updated

Throws:

IfsException - if operation fails

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being freed in order to all delete or modify objects related to the target object. Subclasses are expected to invoke super.preFree.

Overrides:

preFree in class LibraryObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.

registerAuditEventTypes

protected void registerAuditEventTypes()
                                throws IfsException

Register all events defined by this instance's ActionFactory that are not already registered.

Throws:

IfsException - if the operation fails.

getActionFactory

public final ActionFactory getActionFactory()
                                     throws IfsException

Gets the ActionFactory instance implementation corresponding to the ActionClassName, that is used as a factory for subsequent Action instances (pre and post execution).

This implementation is cached for use by the session associated with this instance.

Returns:

the ActionFactory instance

Throws:

IfsException - if the operation fails

(Unpublished)

clearCachedActionFactory

public void clearCachedActionFactory()

Clears the cached ActionFactory.

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

Description copied from class: LibraryObject

Handles the specified event.

Specified by:

handleEvent in interface IfsEventHandler

Overrides:

handleEvent in class LibraryObject

Parameters:

event - the event

Throws:

IfsException - if the operation fails