oracle.ifs.beans

Class ExternalRetentionPolicyDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.beans.RetentionPolicyDefinition

oracle.ifs.beans.ExternalRetentionPolicyDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ExternalRetentionPolicyDefinition
extends RetentionPolicyDefinition

A ExternalRetentionPolicyDefinition is used to create or modify a ExternalRetentionPolicy 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
ExternalRetentionPolicyDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
ExternalRetentionPolicyDefinition(LibrarySessionInterface session, String className) Construct a definition, explicitly capturing the session and setting the initial classobject.

Method Summary

Modifier and Type	Method and Description
static ExternalRetentionPolicyDefinition	toExternalRetentionPolicyDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a ExternalRetentionPolicyDefinition.
static ExternalRetentionPolicyDefinition	toExternalRetentionPolicyDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a ExternalRetentionPolicyDefinition.

Methods inherited from class oracle.ifs.beans.RetentionPolicyDefinition

toRetentionPolicyDefinition, toRetentionPolicyDefinition

Methods inherited from class oracle.ifs.beans.SystemObjectDefinition

addCategoryDefinition, addCategoryDefinitionForUpdate, addCategoryDefinitions, addCategoryForDelete, applySettings, getCategoriesForDelete, getCategoryDefinitions, getCategoryDefinitionsForUpdate, getCreateCategoriesServerSideOption, removeCategoriesForDelete, removeCategoryDefinitions, removeCategoryDefinitionsForUpdate, setCategoryDefinitions, setCreateCategoriesServerSideOption, toSystemObjectDefinition, toSystemObjectDefinition

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

ExternalRetentionPolicyDefinition

public ExternalRetentionPolicyDefinition(LibrarySessionInterface session)
                                  throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

ExternalRetentionPolicyDefinition

public ExternalRetentionPolicyDefinition(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

toExternalRetentionPolicyDefinition

public static ExternalRetentionPolicyDefinition toExternalRetentionPolicyDefinition(LibraryObjectDefinition lodef)
                                                                             throws IfsException

Cast specified LibraryObjectDefinition to a ExternalRetentionPolicyDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a ExternalRetentionPolicyDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toExternalRetentionPolicyDefinition

public static ExternalRetentionPolicyDefinition toExternalRetentionPolicyDefinition(LibraryObjectDefinition lodef,
                                                                                    boolean enforceCompat)
                                                                             throws IfsException

Cast specified LibraryObjectDefinition to a ExternalRetentionPolicyDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a ExternalRetentionPolicyDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)