oracle.ifs.beans

Class LifecycleDateRuleSpecification

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.beans.LifecycleDateRuleSpecification

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieLifecycleDateRuleSpecification

public class LifecycleDateRuleSpecification
extends TieSystemObject

A LifecycleDateRuleSpecification represents a rule used to determine the base lifecycle date for documents associated with a LifecyclePolicy.

Author:

Dave Long

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
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 LifecycleDateRuleSpecification.
static String	LIFECYCLEDATERULECLASSNAME_ATTRIBUTE The name of the attribute that holds the fully-qualified class name of the LifecycleDateRule class.
static String	NAME_ATTRIBUTE The name of the attribute that holds the name of this LifecycleDateRuleSpecification.

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	LifecycleDateRuleSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a LifecycleDateRuleSpecification object.

Method Summary

Modifier and Type	Method and Description
static LifecycleDateRuleSpecification[]	findAll(LibrarySession session) Returns the set of defined LifecycleDateRuleSpecifications.
static LifecycleDateRuleSpecification	findByName(LibrarySession session, String name) Returns the a LifecycleDateRuleSpecification matching the specified name.
String	getDescription() Gets the description of this LifecycleDateRuleSpecification.
LifecycleDateRule	getLifecycleDateRule() Gets the LifecycleDateRule instance implementation corresponding to the LifecycleDateRuleClassName.
String	getLifecycleDateRuleClassName() Gets the Fully-qualified class name of the LifecycleDateRule class.
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	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.
protected void	preUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the update of a PublicObject.

Methods inherited from class oracle.ifs.beans.SystemObject

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

See Also:

Constant Field Values

LIFECYCLEDATERULECLASSNAME_ATTRIBUTE

public static final String LIFECYCLEDATERULECLASSNAME_ATTRIBUTE

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

See Also:

Constant Field Values

Constructor Detail

LifecycleDateRuleSpecification

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

Construct a LifecycleDateRuleSpecification 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

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 LifecycleDateRuleSpecification.

Returns:

the object description

Throws:

IfsException - if operation fails

getLifecycleDateRuleClassName

public String getLifecycleDateRuleClassName()
                                     throws IfsException

Gets the Fully-qualified class name of the LifecycleDateRule class.

Returns:

the object description

Throws:

IfsException - if operation fails

findAll

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

Returns the set of defined LifecycleDateRuleSpecifications.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of LifecycleDateRuleSpecifications; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

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

Returns the a LifecycleDateRuleSpecification matching the specified name.

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

Parameters:

session - the session context

name - the LifecycleDateRuleSpecification name

Returns:

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

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

preUpdate

protected void preUpdate(LibraryObjectDefinition lodef)
                  throws IfsException

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

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

Overrides:

preUpdate in class SystemObject

Parameters:

lodef - definition used to define how the target object will be updated

Throws:

IfsException - if operation fails

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

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.

getLifecycleDateRule

public final LifecycleDateRule getLifecycleDateRule()
                                             throws IfsException

Gets the LifecycleDateRule instance implementation corresponding to the LifecycleDateRuleClassName.

This implementation is cached for use by the session associated with this instance. There is no guarantee that there is only one implementation in use for the session if the session is used in multiple threads.

Returns:

the LifecycleDateRule implementation

Throws:

IfsException - if the operation fails

(Unpublished)

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

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