oracle.ifs.beans

Class DefinitionObjectDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.ApplicationObjectDefinition

oracle.ifs.beans.PropertyBundleDefinition

oracle.ifs.beans.DefinitionObjectDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class DefinitionObjectDefinition
extends PropertyBundleDefinition

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

Method Summary

Modifier and Type	Method and Description
LibraryObjectDefinition	getTargetDefinition() get the target definition that this DefinitionObject is to represent.
void	setEmbedded(boolean value) Set the EMBEDDED attribute.
void	setTargetDefinition(LibraryObjectDefinition lodef) Set the target definition that this DefinitionObject is to represent.
static DefinitionObjectDefinition	toDefinitionObjectDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a DefinitionObjectDefinition.
static DefinitionObjectDefinition	toDefinitionObjectDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a DefinitionObjectDefinition.

Methods inherited from class oracle.ifs.beans.PropertyBundleDefinition

addPropertyDefinition, addPropertyDefinition, addPropertyDefinitions, addPropertyDefinitions, addPropertyValue, addPropertyValue, applySettings, getPropertyDefinitions, removePropertyDefinitions, setPropertyDefinitions, toPropertyBundleDefinition

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, 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, 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, getReferenceAttribute, getReferenceAttributes, getServerDefinition, getSession, getSimplePropertyDefinitions, getSLibrarySession, getStringAttribute, getSystemOption, getSystemOptionAsAttributeValue, getSystemOptionAsBoolean, getSystemOptionKeys, getWriteableInstance, isReadOnly, prepareForDefinitionObject, processSimplePropertiesForCreate, processSimplePropertiesForUpdate, removeAttribute, removeContentSpecification, removeDefinition, removeDefinitions, removeOption, 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

DefinitionObjectDefinition

public DefinitionObjectDefinition(LibrarySessionInterface session)
                           throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

DefinitionObjectDefinition

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

setTargetDefinition

public void setTargetDefinition(LibraryObjectDefinition lodef)
                         throws IfsException

Set the target definition that this DefinitionObject is to represent.

Parameters:

lodef - the definition

Throws:

IfsException - if the operation fails

(Unpublished)

getTargetDefinition

public LibraryObjectDefinition getTargetDefinition()
                                            throws IfsException

get the target definition that this DefinitionObject is to represent.

Returns:

the definition

Throws:

IfsException - if the operation fails

(Unpublished)

setEmbedded

public void setEmbedded(boolean value)
                 throws IfsException

Set the EMBEDDED attribute.

Parameters:

value - the value of the attribute

Throws:

IfsException - if the operation fails

(Unpublished)

toDefinitionObjectDefinition

public static DefinitionObjectDefinition toDefinitionObjectDefinition(LibraryObjectDefinition lodef)
                                                               throws IfsException

Cast specified LibraryObjectDefinition to a DefinitionObjectDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a DefinitionObjectDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toDefinitionObjectDefinition

public static DefinitionObjectDefinition toDefinitionObjectDefinition(LibraryObjectDefinition lodef,
                                                                      boolean enforceCompat)
                                                               throws IfsException

Cast specified LibraryObjectDefinition to a DefinitionObjectDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a DefinitionObjectDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)