oracle.ifs.beans

Class MediaCustomDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.beans.MediaDefinition

oracle.ifs.beans.MediaCustomDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class MediaCustomDefinition
extends MediaDefinition

A MediaCustomDefinition is used to create or modify a MediaCustom instance.

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
MediaCustomDefinition(LibrarySessionInterface session) Constructs a MediaCustomDefinition.
MediaCustomDefinition(LibrarySessionInterface session, String className) Constructs a MediaCustomDefinition.

Method Summary

Modifier and Type	Method and Description
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
static MediaCustomDefinition	toMediaCustomDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to a MediaCustomDefinition.
static MediaCustomDefinition	toMediaCustomDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Casts the specified LibraryObjectDefinition to a MediaCustomDefinition.

Methods inherited from class oracle.ifs.beans.MediaDefinition

getAlterTableSuffix, getCreateTableSuffix, setAlterTableSuffix, setCreateTableSuffix, toMediaDefinition, toMediaDefinition

Methods inherited from class oracle.ifs.beans.SystemObjectDefinition

addCategoryDefinition, addCategoryDefinitionForUpdate, addCategoryDefinitions, addCategoryForDelete, 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

MediaCustomDefinition

public MediaCustomDefinition(LibrarySessionInterface session)
                      throws IfsException

Constructs a MediaCustomDefinition.

Equivalent to MediaCustomDefinition(session, MediaCustom.CLASS_NAME).

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

MediaCustomDefinition

public MediaCustomDefinition(LibrarySessionInterface session,
                             String className)
                      throws IfsException

Constructs a MediaCustomDefinition.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

(Published)

Method Detail

applySettings

public void applySettings(AttributeValueTable avt)
                   throws IfsException

Applies settings from the specified table.

Overrides:

applySettings in class MediaDefinition

Parameters:

avt - the table having the definition settings

Throws:

IfsException - if the operation fails

(Published)

toMediaCustomDefinition

public static MediaCustomDefinition toMediaCustomDefinition(LibraryObjectDefinition lodef)
                                                     throws IfsException

Casts the specified LibraryObjectDefinition to a MediaCustomDefinition.

Returns null if the specified definition is not a MediaCustomDefinition, or if the specified definition is null.

Parameters:

lodef - the definition

Returns:

the MediaCustomDefinition or null

Throws:

IfsException - is not currently thrown

(Unpublished)

toMediaCustomDefinition

public static MediaCustomDefinition toMediaCustomDefinition(LibraryObjectDefinition lodef,
                                                            boolean enforceCompat)
                                                     throws IfsException

Casts the specified LibraryObjectDefinition to a MediaCustomDefinition.

Returns the MediaCustomDefinition, or null if the specified definition is null. If the cast fails, returns null if enforceCompat is false or throws IfsException if enforceCompat is true.

Parameters:

lodef - the definition to cast

enforceCompat - whether to throw an exception if the cast fails

Returns:

the MediaCustomDefinition

Throws:

IfsException - (IFS-10822) if the operation fails

(Unpublished)