oracle.ifs.beans

Class LifecyclePolicy

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.beans.LifecyclePolicy

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieLifecyclePolicy

public class LifecyclePolicy
extends TieSystemObject

A LifecyclePolicy represents lifecycle rules that are applied to documents.

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 a textual description of the LifecyclePolicy.
static String	LIFECYCLEDATERULE_ATTRIBUTE The name of the attribute that references the rule in effect that determines the LifecycleDate of the Document associated with this LifecyclePolicy.
static String	LOCKIMPLIED_ATTRIBUTE The name of the attribute that indicates whether document instances that reference this LifecyclePolicy are implicitly locked.
static String	NAME_ATTRIBUTE The name of the attribute that holds the name of this LifecyclePolicy.
static String	REFERENCED_ATTRIBUTE The name of the attribute that indicates whether any document instances reference this RetentionPolicy.

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

Method Summary

Modifier and Type	Method and Description
void	applyLock(Document doc) Apply a lock on the specified document, as it is in the process of referencing this LifecyclePolicy.
void	applyLock(DocumentDefinition def) Apply a lock on the specified document definition, as it is in the process of referencing this LifecyclePolicy.
void	applyUnlock(Document doc) Release the lock held on the specified document, as it is in the process of not referencing this LifecyclePolicy.
static LifecyclePolicy[]	findAll(LibrarySession session) Returns the set of defined LifecyclePolicy instances.
static LifecyclePolicy	findByName(LibrarySession session, String name) Returns a LifecyclePolicy matching the specified name.
String	getDescription() Gets the description of this LifecyclePolicy.
LifecycleDateRuleSpecification	getLifecycleDateRuleSpecification() Gets the LifecycleDateRuleSpecification which holds the rule for determining the LifecycleDate for documents under the control of this LifecyclePolicy.
LifecyclePolicyEntry[]	getLifecyclePolicyEntries() Returns the set of LifecyclePolicyEntry defined for this LifecyclePolicy.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
boolean	isLockImplied() Gets the indication of whether document instances that reference this LifecyclePolicy are implicitly locked.
boolean	isReferenced() Gets the indication of whether any document instances reference this LifecyclePolicy.
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.
void	setReferenced(boolean active) Sets the REFERENCED attribute for this object.

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, handleEvent, 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 LifecyclePolicy. (String[700])

See Also:

Constant Field Values

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

The name of the attribute that holds a textual description of the LifecyclePolicy. (String[2000])

See Also:

Constant Field Values

LOCKIMPLIED_ATTRIBUTE

public static final String LOCKIMPLIED_ATTRIBUTE

The name of the attribute that indicates whether document instances that reference this LifecyclePolicy are implicitly locked. (Boolean)

See Also:

Constant Field Values

REFERENCED_ATTRIBUTE

public static final String REFERENCED_ATTRIBUTE

The name of the attribute that indicates whether any document instances reference this RetentionPolicy. (Boolean)

See Also:

Constant Field Values

LIFECYCLEDATERULE_ATTRIBUTE

public static final String LIFECYCLEDATERULE_ATTRIBUTE

The name of the attribute that references the rule in effect that determines the LifecycleDate of the Document associated with this LifecyclePolicy. (SystemObject; ClassDomain enforces a LifecycleDateRuleSpecification)

See Also:

Constant Field Values

Constructor Detail

LifecyclePolicy

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

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

Returns:

the object description

Throws:

IfsException - if operation fails

isLockImplied

public boolean isLockImplied()
                      throws IfsException

Gets the indication of whether document instances that reference this LifecyclePolicy are implicitly locked.

Returns:

true if Documents referencing this LifecyclePolicy; are implicitly locked; false otherwise

Throws:

IfsException - if operation fails

isReferenced

public boolean isReferenced()
                     throws IfsException

Gets the indication of whether any document instances reference this LifecyclePolicy.

Returns:

true if document instances exist that reference this; false otherwise

Throws:

IfsException - if operation fails

getLifecycleDateRuleSpecification

public LifecycleDateRuleSpecification getLifecycleDateRuleSpecification()
                                                                 throws IfsException

Gets the LifecycleDateRuleSpecification which holds the rule for determining the LifecycleDate for documents under the control of this LifecyclePolicy.

Returns:

the LifecycleDateRuleSpecification

Throws:

IfsException - if operation fails

getLifecyclePolicyEntries

public LifecyclePolicyEntry[] getLifecyclePolicyEntries()
                                                 throws IfsException

Returns the set of LifecyclePolicyEntry defined for this LifecyclePolicy.

Returns null if no LifecyclePolicyEntry objects are associated.

Returns:

array of associated LifecyclePolicyEntries

Throws:

IfsException - if operation fails

setReferenced

public void setReferenced(boolean active)
                   throws IfsException

Sets the REFERENCED attribute for this object.

This is set to true the first time a document references this policy. It is eventually set to false once it is determined that no documents still reference the policy.

Parameters:

active - the new REFERENCED status value

Throws:

IfsException - if operation fails.

(Published)

applyLock

public void applyLock(DocumentDefinition def)
               throws IfsException

Apply a lock on the specified document definition, as it is in the process of referencing this LifecyclePolicy.

Called from within the create operation on Document, when this LifecyclePolicy is being referenced by the Document.

Parameters:

def - the Document that is now referencing this policy

Throws:

IfsException - if operation fails.

applyLock

public void applyLock(Document doc)
               throws IfsException

Apply a lock on the specified document, as it is in the process of referencing this LifecyclePolicy.

Called from within the update operation on Document, when this LifecyclePolicy is being referenced by the Document.

Parameters:

doc - the Document that is now referencing this policy

Throws:

IfsException - if operation fails.

applyUnlock

public void applyUnlock(Document doc)
                 throws IfsException

Release the lock held on the specified document, as it is in the process of not referencing this LifecyclePolicy.

Called from within the update operation on Document, when a previously referenced record LifecyclePolicy was being referenced. This instance is the previously referenced LifecyclePolicy.

Parameters:

doc - the Document that was referencing this policy

Throws:

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

findAll

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

Returns the set of defined LifecyclePolicy instances.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of LifecyclePolicy instances; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

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

Returns a LifecyclePolicy matching the specified name.

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

Parameters:

session - the session context

name - the LifecyclePolicy name

Returns:

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

Throws:

IfsException - if the operation fails.