oracle.ifs.beans

Class AttachmentRelationDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.CategoryDefinition

oracle.ifs.beans.RelationDefinition

oracle.ifs.beans.AttachmentRelationDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class AttachmentRelationDefinition
extends RelationDefinition

An AttachmentRelationDefinition is used to define or update AttachmentRelation instances.

Author:

Oskar Wetterstein

See Also:

Serialized Form

(Published)

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
AttachmentRelationDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
AttachmentRelationDefinition(LibrarySessionInterface session, String className) Construct a definition explicitly capturing the session and setting the initial ClassObject name.

Method Summary

Modifier and Type	Method and Description
Document	getAttachment() Gets the related attached Document, if explicitly set.
void	setAttachment(Document doc) Sets the related attached Document.
static AttachmentRelationDefinition	toAttachmentRelationDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a AttachmentRelationDefinition.
static AttachmentRelationDefinition	toAttachmentRelationDefinition(LibraryObjectDefinition lodef, boolean enforce) Cast specified LibraryObjectDefinition to a AttachmentRelationDefinition.

Methods inherited from class oracle.ifs.beans.RelationDefinition

getRelatedObject, setRelatedObject, toRelationDefinition, toRelationDefinition

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

AttachmentRelationDefinition

public AttachmentRelationDefinition(LibrarySessionInterface session)
                             throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be AttachmentRelation.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

AttachmentRelationDefinition

public AttachmentRelationDefinition(LibrarySessionInterface session,
                                    String className)
                             throws IfsException

Construct a definition explicitly capturing the session and setting the initial ClassObject name.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

Method Detail

getAttachment

public Document getAttachment()
                       throws IfsException

Gets the related attached Document, if explicitly set.

Returns:

the related attached Document, or null if not set

Throws:

IfsException - if operation fails

setAttachment

public void setAttachment(Document doc)
                   throws IfsException

Sets the related attached Document.

Parameters:

doc - the related attached Document.

Throws:

IfsException - if operation fails

toAttachmentRelationDefinition

public static AttachmentRelationDefinition toAttachmentRelationDefinition(LibraryObjectDefinition lodef)
                                                                   throws IfsException

Cast specified LibraryObjectDefinition to a AttachmentRelationDefinition.

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

Parameters:

lodef - the definition to be cast

Returns:

a AttachmentRelationDefinition cast from the specified definition

Throws:

IfsException - if the operation fails

toAttachmentRelationDefinition

public static AttachmentRelationDefinition toAttachmentRelationDefinition(LibraryObjectDefinition lodef,
                                                                          boolean enforce)
                                                                   throws IfsException

Cast specified LibraryObjectDefinition to a AttachmentRelationDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw otherwise.

Parameters:

lodef - the definition to be cast

enforce - whether to throw an exception if cast fails

Returns:

a AttachmentRelationDefinition cast from the specified definition

Throws:

IfsException - if the operation fails (throws 10822)