oracle.ifs.beans

Class ActivitySpecification

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.beans.ActivitySpecification

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieActivitySpecification

public class ActivitySpecification
extends TieSystemObject

A ActivitySpecification is used to define a set of Activity that is captured within ActivityRecords associated with PublicObjects.

It also manages the construction and caching of a particular instance of ActivityProcessor, using properties defined on the instance.

Author:

Dave Long

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIONSPECIFICATIONS_ATTRIBUTE The name of the attribute that holds the set of ActionSpecifications that define the allowable activity for this instance.
static String	ACTIVITYPROCESSORCLASSNAME_ATTRIBUTE The name of the attribute that holds fully-qualified class name of the Activity class.
static String	ACTIVITYRECORDCLASS_ATTRIBUTE The name of the attribute that holds the ClassObject to use for newly created ActivityRecords for activity defined by this instance.
static String	ACTIVITYSPECIFICATION_HIERARCHY_TABLENAME The table name which contains the ActivitySpecification 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 ActivitySpecification.
static String	NAME_ATTRIBUTE The name of the attribute that holds the name of this ActivitySpecification.
static String	SUPERACTIVITYSPECIFICATION_ATTRIBUTE The ActivitySpecification whose ActivityProcessor 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	ActivitySpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a ActivitySpecification object.

Method Summary

Modifier and Type	Method and Description
void	clearCachedActivityProcessor() Clears the cached ActivityProcessor.
static ActivitySpecification[]	findAll(LibrarySession session) Returns the set of defined ActivitySpecifications.
static ActivitySpecification	findByName(LibrarySession session, String name) Returns the a ActivitySpecification matching the specified name.
ActionSpecification[]	getActionSpecifications() Gets the ActionSpecifications that represent the Actions that can be posted for ActivityRecords that reference this ActivitySpecification - effectively defining the allowable activity for this ActivitySpecification instance.
ActivityProcessor	getActivityProcessor() Gets the ActivityProcessor instance implementation corresponding to the ActivityProcessorClassName, that is used to process Activity for the activity defined by this instance.
String	getActivityProcessorClassName() Gets the fully-qualified class name of the ActivityProcessor class.
ClassObject	getActivityRecordClass() Gets the ClassObject to use for newly created ActivityRecords for activity defined by this instance.
String	getDescription() Gets the description of this ActivitySpecification.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySession session) Returns the LibraryObjectLookupCache used by find ActivitySpecification instances by name.
AttributeValueTable	getPropertyTable() Gets the AttributeValueTable representing the set of Properties defined for this instance.
ActivitySpecification	getSuperActivitySpecification() Gets the ActivitySpecification whose ActivityProcessor 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	preCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the creation of a PublicObject.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postUpdate, 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 ActivitySpecification. (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 ActivitySpecification. (String[2000])

See Also:

Constant Field Values

ACTIVITYPROCESSORCLASSNAME_ATTRIBUTE

public static final String ACTIVITYPROCESSORCLASSNAME_ATTRIBUTE

The name of the attribute that holds fully-qualified class name of the Activity class. (String[700])

See Also:

Constant Field Values

ACTIVITYRECORDCLASS_ATTRIBUTE

public static final String ACTIVITYRECORDCLASS_ATTRIBUTE

The name of the attribute that holds the ClassObject to use for newly created ActivityRecords for activity defined by this instance. (String[700])

See Also:

Constant Field Values

ACTIONSPECIFICATIONS_ATTRIBUTE

public static final String ACTIONSPECIFICATIONS_ATTRIBUTE

The name of the attribute that holds the set of ActionSpecifications that define the allowable activity for this instance. (SystemObject[])

See Also:

Constant Field Values

SUPERACTIVITYSPECIFICATION_ATTRIBUTE

public static final String SUPERACTIVITYSPECIFICATION_ATTRIBUTE

The ActivitySpecification whose ActivityProcessor class is the designated superclass for this instance.

See Also:

Constant Field Values

ACTIVITYSPECIFICATION_HIERARCHY_TABLENAME

public static final String ACTIVITYSPECIFICATION_HIERARCHY_TABLENAME

The table name which contains the ActivitySpecification hierarchy.

See Also:

Constant Field Values

Constructor Detail

ActivitySpecification

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

Construct a ActivitySpecification 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 ActivitySpecification.

Returns:

the object description

Throws:

IfsException - if operation fails

getActivityProcessorClassName

public String getActivityProcessorClassName()
                                     throws IfsException

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

Returns:

the class name of the ActivityProcessor

Throws:

IfsException - if operation fails

getActionSpecifications

public ActionSpecification[] getActionSpecifications()
                                              throws IfsException

Gets the ActionSpecifications that represent the Actions that can be posted for ActivityRecords that reference this ActivitySpecification - effectively defining the allowable activity for this ActivitySpecification instance.

Returns:

the ActionSpecifications, or null if none are defined

Throws:

IfsException - if the operation fails

(Published)

getActivityRecordClass

public ClassObject getActivityRecordClass()
                                   throws IfsException

Gets the ClassObject to use for newly created ActivityRecords for activity defined by this instance.

Returns:

the ClassObject to use for ActivityRecords

Throws:

IfsException - if operation fails

getSuperActivitySpecification

public ActivitySpecification getSuperActivitySpecification()
                                                    throws IfsException

Gets the ActivitySpecification whose ActivityProcessor class is the designated superclass for this instance.

Returns:

the super ActivitySpecification

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

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find ActivitySpecification instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

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

Returns the set of defined ActivitySpecifications.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of ActivitySpecifications; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

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

Returns the a ActivitySpecification matching the specified name.

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

Parameters:

session - the session context

name - the ActivitySpecification name

Returns:

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

Throws:

IfsException - if the operation fails.

preCreate

protected void preCreate(LibraryObjectDefinition lodef)
                  throws IfsException

Extensibility point to perform actions prior to the creation of a PublicObject.

Set an option that indicates that Categories are NOT to be created from within S_SystemObject.

Overrides:

preCreate in class SystemObject

Parameters:

lodef - object definition that will be used to create the object

Throws:

IfsException - if 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

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.

getActivityProcessor

public final ActivityProcessor getActivityProcessor()
                                             throws IfsException

Gets the ActivityProcessor instance implementation corresponding to the ActivityProcessorClassName, that is used to process Activity for the activity defined by this instance.

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

Returns:

the ActivityProcessor implementation

Throws:

IfsException - if the operation fails

(Unpublished)

clearCachedActivityProcessor

public void clearCachedActivityProcessor()

Clears the cached ActivityProcessor.

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