oracle.ifs.beans

Class RelationDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.CategoryDefinition

oracle.ifs.beans.RelationDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ActorRelationDefinition, AttachmentRelationDefinition, ConversationRelationDefinition, StixRelationObjectDefinition

public class RelationDefinition
extends CategoryDefinition

A RelationDefinition is used to create or modify a Relation instance.

Author:

Dave Long

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

Method Summary

Modifier and Type	Method and Description
PublicObject	getRelatedObject() Gets the the related object, if explicitly set.
void	setRelatedObject(PublicObject obj) Sets the related object.
static RelationDefinition	toRelationDefinition(LibraryObjectDefinition lodef) Casts specified LibraryObjectDefinition to a RelationDefinition.
static RelationDefinition	toRelationDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Casts specified LibraryObjectDefinition to a RelationDefinition.

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

RelationDefinition

public RelationDefinition(LibrarySessionInterface session)
                   throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be Relation.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

RelationDefinition

public RelationDefinition(LibrarySessionInterface session,
                          String className)
                   throws IfsException

Constructs 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

Method Detail

getRelatedObject

public PublicObject getRelatedObject()
                              throws IfsException

Gets the the related object, if explicitly set.

Returns:

the related object, or null if not set

Throws:

IfsException - if operation fails

setRelatedObject

public void setRelatedObject(PublicObject obj)
                      throws IfsException

Sets the related object.

Parameters:

obj - the related object.

Throws:

IfsException - if operation fails

toRelationDefinition

public static RelationDefinition toRelationDefinition(LibraryObjectDefinition lodef)
                                               throws IfsException

Casts specified LibraryObjectDefinition to a RelationDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a RelationDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown

toRelationDefinition

public static RelationDefinition toRelationDefinition(LibraryObjectDefinition lodef,
                                                      boolean enforceCompat)
                                               throws IfsException

Casts specified LibraryObjectDefinition to a RelationDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a RelationDefinition casted from the specified definition

Throws:

IfsException - 10822: if operation fails