oracle.ifs.beans

Class ActivityRecordDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.CategoryDefinition

oracle.ifs.beans.ActivityRecordDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ActivityRecordDefinition
extends CategoryDefinition

A ActivityRecordDefinition is used to create or modify a ActivityRecord instance.

Author:

Dave Long

See Also:

Serialized Form

(Unpublished)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.beans.LibraryObjectDefinition

LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByName

Field Summary

Fields inherited from class oracle.ifs.beans.LibraryObjectDefinition

m_Attributes, m_ClassObjectName, m_ClassObjectValue, m_ContentSpecifications, m_DefinitionLists, m_Definitions, m_EnclosedDefinition, m_Id, m_Options, m_ReadOnly, m_ReferenceAttributes, m_Session, m_SystemOptions

Constructor Summary

Constructors

Constructor and Description
ActivityRecordDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
ActivityRecordDefinition(LibrarySessionInterface session, String className) Construct a definition, explicitly capturing the session and setting the initial classobject.

Method Summary

Modifier and Type	Method and Description
ActivitySpecification	getActivitySpecification() Gets the ActivitySpecification, if explicitly set.
AuditSpecification	getEventHistory() Gets the event history, if explicitly set.
void	setActivitySpecification(ActivitySpecification spec) Sets the ActivitySpecification that defines the activity that will be recorded for this instance.
void	setEventHistory(AuditSpecification spec) Sets the event history.
static ActivityRecordDefinition	toActivityRecordDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a ActivityRecordDefinition.
static ActivityRecordDefinition	toActivityRecordDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a ActivityRecordDefinition.

Methods inherited from class oracle.ifs.beans.CategoryDefinition

getUpdateAssociatedObjectOption, setUpdateAssociatedObjectOption, toCategoryDefinition, toCategoryDefinition

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, applySettings, getAddToFolderOption, getAddToFolderValue, getAutoFolderingActionSpecification, getCascadeCopyRelationshipsOption, getCascadeCopyRelationshipsOptionValue, getCategoryCopyOption, getCategoryDefinitions, getContentQuotaCopyOption, getCreateCategoriesServerSideOption, getExplicitCreateAndModifyAttributesOption, getExplicitCreateDate, getExplicitLastModifyDate, getFreeIfLastFolderReferenceOption, getKeepLastModifierOption, getKeepLastModifyDateOption, getLockEntryDefinition, getLockObject, getLockObjectDefinition, getLockObjectValue, getSecuringPublicObject, getSecuringPublicObjectValue, getUpdatedLockObjectDefinition, removeCategoryDefinitions, removeLockEntryDefinition, resolveAutoFolderingSettings, setAddToFolderOption, setAddToFolderValue, setAutoFolderingActionSpecification, setAutoFolderingActionSpecification, setCascadeCopyRelationshipsOption, setCategoryCopyOption, setCategoryDefinitions, setContentQuotaCopyOption, setCreateCategoriesServerSideOption, setExplicitCreateAndModifyAttributesOption, setExplicitCreateDate, setExplicitLastModifyDate, setFreeIfLastFolderReferenceOption, setKeepLastModifierOption, setKeepLastModifyDateOption, setLockEntryDefinition, setLockObject, setLockObjectDefinition, setLockObjectValue, setNullSecurity, setPrivateSecurity, setPublishedSecurity, setSecuringPublicObject, setSecuringPublicObjectValue, setUpdatedLockObjectDefinition, toPublicObjectDefinition, toPublicObjectDefinition

Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition

addDefinition, addDefinitions, addProperty, addPropertyDefinition, addPropertyDefinition, addPropertyDefinitions, addPropertyDefinitions, addSimplePropertyDefinition, addSimplePropertyDefinition, addSimplePropertyDefinitions, addSimplePropertyDefinitions, applyEnumSetting, applyEnumSetting, applyMapSetting, applyMapSetting, applyObjectArraySetting, applyObjectArraySetting, applyObjectSetting, applyObjectSetting, applySetting, applySetting, captureSession, captureSession, captureSession, clone, constructInstance, constructInstance, constructInstance, copyInto, deriveObjectArraySetting, deriveObjectSetting, getAttribute, getAttribute, getAttributes, getAttributes, getAttributesSorted, getClassId, getClassObject, getClassObjectValue, getContentSpecification, getContentSpecificationKeys, getCopiedObjectValue, getDefinition, getDefinitionClassName, getDefinitionKeys, getDefinitionListKeys, getDefinitions, getId, getLibrarySession, getName, getOption, getOptionAsAttributeValue, getOptionKeys, getPolicyMode, getPropertyDefinitions, getReferenceAttribute, getReferenceAttributes, getServerDefinition, getSession, getSimplePropertyDefinitions, getSLibrarySession, getStringAttribute, getSystemOption, getSystemOptionAsAttributeValue, getSystemOptionAsBoolean, getSystemOptionKeys, getWriteableInstance, isReadOnly, prepareForDefinitionObject, processSimplePropertiesForCreate, processSimplePropertiesForUpdate, removeAttribute, removeContentSpecification, removeDefinition, removeDefinitions, removeOption, removePropertyDefinitions, removeReferenceAttribute, removeSimplePropertyDefinitions, removeSystemOption, reset, resolve, setAttribute, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributeByUpperCaseName, setAttributePolicyMode, setAttributes, setClassId, setClassname, setClassObject, setClassObjectValue, setContentSpecification, setCopiedObjectValue, setDefinition, setDefinitions, setId, setName, setOption, setReadOnly, setReferenceAttribute, setReferenceAttribute, setSession, setSimplePropertyDefinitions, setSystemOption, unresolve, verifySession

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityRecordDefinition

public ActivityRecordDefinition(LibrarySessionInterface session)
                         throws IfsException

Construct a definition explicitly capturing the session. The initial ClassObject will be ActivityRecord.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

ActivityRecordDefinition

public ActivityRecordDefinition(LibrarySessionInterface session,
                                String className)
                         throws IfsException

Construct a definition, explicitly capturing the session and setting the initial classobject.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getEventHistory

public AuditSpecification getEventHistory()
                                   throws IfsException

Gets the event history, if explicitly set.

Returns:

the event history setting, or null if not set

Throws:

IfsException - if operation fails

getActivitySpecification

public ActivitySpecification getActivitySpecification()
                                               throws IfsException

Gets the ActivitySpecification, if explicitly set.

Returns:

the ActivitySpecification setting, or null if not set

Throws:

IfsException - if operation fails

setEventHistory

public void setEventHistory(AuditSpecification spec)
                     throws IfsException

Sets the event history.

Parameters:

spec - the event history setting

Throws:

IfsException - if operation fails

setActivitySpecification

public void setActivitySpecification(ActivitySpecification spec)
                              throws IfsException

Sets the ActivitySpecification that defines the activity that will be recorded for this instance.

Parameters:

spec - the ActivitySpecification setting

Throws:

IfsException - if operation fails

toActivityRecordDefinition

public static ActivityRecordDefinition toActivityRecordDefinition(LibraryObjectDefinition lodef)
                                                           throws IfsException

Cast specified LibraryObjectDefinition to a ActivityRecordDefinition.

Return null if the specified definition is not a ActivityRecordDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be casted

Returns:

a ActivityRecordDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toActivityRecordDefinition

public static ActivityRecordDefinition toActivityRecordDefinition(LibraryObjectDefinition lodef,
                                                                  boolean enforceCompat)
                                                           throws IfsException

Cast specified LibraryObjectDefinition to a ActivityRecordDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw an IfsException if the specified definition is not a ActivityRecordDefinition.

Parameters:

lodef - the definition to be casted

enforceCompat - whether to throw an exception if a non-null definition cannot be cast

Returns:

a ActivityRecordDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)