oracle.ifs.beans

Class InterMediaSourceDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.CategoryDefinition

oracle.ifs.beans.InterMediaSourceDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

InterMediaAudioDefinition, InterMediaImageDefinition, InterMediaMovieDefinition, InterMediaVideoDefinition

public class InterMediaSourceDefinition
extends CategoryDefinition

The InterMediaSourceDefinition class

Version:

1.0

Author:

Larry Matter

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

Method Summary

Modifier and Type	Method and Description
String	getTextLanguage() gets the language of the text reader, if any
Reader	getTextReader() Gets the Reader from which text content will be loaded.
void	setTextLanguage(String language) sets the language of the text reader, if any
void	setTextReader(Reader textReader) Sets the content Reader from which text content will be loaded/created.
static InterMediaSourceDefinition	toInterMediaSourceDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a InterMediaSourceDefinition.
static InterMediaSourceDefinition	toInterMediaSourceDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a InterMediaSourceDefinition.

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

InterMediaSourceDefinition

public InterMediaSourceDefinition(LibrarySessionInterface session)
                           throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

InterMediaSourceDefinition

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

setTextReader

public void setTextReader(Reader textReader)
                   throws IfsException

Sets the content Reader from which text content will be loaded/created. Text content is the text that will be indexed (as apposed to the actual rich-media content).

Parameters:

textReader - an Reader from which content will be loaded/created.

Throws:

IfsException - if the operation fails.

(Published)

getTextReader

public Reader getTextReader()
                     throws IfsException

Gets the Reader from which text content will be loaded. or null if no Reader was specified. Text content is the text that will be indexed (as apposed to the actual rich-media content).

Returns:

the content Reader

Throws:

IfsException - if the operation fails.

(Published)

setTextLanguage

public void setTextLanguage(String language)
                     throws IfsException

sets the language of the text reader, if any

Parameters:

language - the language of the text reader. Used for Oracle Text indexing

Throws:

IfsException - if the operation fails

(Published)

getTextLanguage

public String getTextLanguage()
                       throws IfsException

gets the language of the text reader, if any

Returns:

language the language of the text reader.

Throws:

IfsException - if the operation fails

(Published)

toInterMediaSourceDefinition

public static InterMediaSourceDefinition toInterMediaSourceDefinition(LibraryObjectDefinition lodef)
                                                               throws IfsException

Cast specified LibraryObjectDefinition to a InterMediaSourceDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a InterMediaSourceDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toInterMediaSourceDefinition

public static InterMediaSourceDefinition toInterMediaSourceDefinition(LibraryObjectDefinition lodef,
                                                                      boolean enforceCompat)
                                                               throws IfsException

Cast specified LibraryObjectDefinition to a InterMediaSourceDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a InterMediaSourceDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)