oracle.ifs.beans

Class Media

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.beans.Media

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieMedia

public abstract class Media
extends TieSystemObject

A Media identifies an available storage mechanism for binary content.

The Media classobject is abstract. It is subtyped for each type of storage mechanism. Instances of these subtypes are instantiated to identify the available Media.

For example, MediaBlob and MediaBfile classobjects subtype Media to store binary content in database BLOBs and BFILEs, respectively. A hypothetical repository might have one MediaBlob instance named "DefaultMedia" and two MediaBfile instances named "Disk1Bfiles" and "Disk2Bfiles" (for example, if the BFILEs were spread across two disks on the database server's file system).

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	COLUMNNAME_ATTRIBUTE The name of the attribute whose value is the name of the content table column in which content is stored by a Media.
static String	CONTENTINDEXPROCEDURE_ATTRIBUTE The name of the attribute whose value is the name of the stored procedure called by Oracle Text to retrieve content, or null for indirect full-text indexing.
static String	DESCRIPTION_ATTRIBUTE A textual description of this object.
static String	MEDIAOPTION_ALLOW_NONTRANSACTIONAL_CONTENT_DESTRUCTION The name of the media option whose boolean value indicates whether non-transactional destruction of content is acceptable in freeing a ContentObject.
static String	READONLY_ATTRIBUTE The name of the attribute whose value indicates whether a Media is read-only.
static String	TABLENAME_ATTRIBUTE The name of the attribute whose value specifies in which content table content is stored by a Media.

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, NAME_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Media(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a Media object.

Method Summary

Modifier and Type	Method and Description
static Media[]	findAll(LibrarySession session) Returns the set of defined Medias.
static Media	findByName(LibrarySession session, String name) Returns the a Media matching the specified name.
String	getColumnName() Gets the value of the COLUMNNAME attribute.
String	getContentIndexProcedure() Gets the name of the stored procedure called by Oracle Text to retrieve content, or null for indirect full-text indexing.
String	getDescription() Returns the description of this object.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySessionInterface session) Returns the LibraryObjectLookupCache used by find Media instances by name.
String	getTableName() Gets the value of the TABLENAME attribute.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
boolean	isReadOnly() Gets the value of the READONLY attribute.

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, preFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

(Published)

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

A textual description of this object.

See Also:

Constant Field Values

(Published)

TABLENAME_ATTRIBUTE

public static final String TABLENAME_ATTRIBUTE

The name of the attribute whose value specifies in which content table content is stored by a Media.

The name of the content table is formed by prepending "ODMM_" to the uppercased value of this attribute.

See Also:

Constant Field Values

(Published)

COLUMNNAME_ATTRIBUTE

public static final String COLUMNNAME_ATTRIBUTE

The name of the attribute whose value is the name of the content table column in which content is stored by a Media.

See Also:

Constant Field Values

(Published)

READONLY_ATTRIBUTE

public static final String READONLY_ATTRIBUTE

The name of the attribute whose value indicates whether a Media is read-only.

Content cannot be stored on or removed from a read-only Media.

See Also:

Constant Field Values

(Published)

CONTENTINDEXPROCEDURE_ATTRIBUTE

public static final String CONTENTINDEXPROCEDURE_ATTRIBUTE

The name of the attribute whose value is the name of the stored procedure called by Oracle Text to retrieve content, or null for indirect full-text indexing.

See Also:

Constant Field Values

(Published)

MEDIAOPTION_ALLOW_NONTRANSACTIONAL_CONTENT_DESTRUCTION

public static final String MEDIAOPTION_ALLOW_NONTRANSACTIONAL_CONTENT_DESTRUCTION

The name of the media option whose boolean value indicates whether non-transactional destruction of content is acceptable in freeing a ContentObject.

Some types of Media may not be natively transactional: content created and destroyed in such Media is not automatically rolled back if the the session's transaction is aborted. For such Media, transactional behavior is emulated using compensating operations performed by the ContentAgent.

In freeing a ContentObject, if the value of this media option is false, the destruction of content must be transactional (either natively transactional or emulated transactional behavior). If the transaction in which the ContentObject was freed is aborted, the content must still exist. This is the default.

If true, destruction of content may be non-transactional. Even if the transaction in which the ContentObject was freed is aborted, the content may no longer exist and subsequent operations on the content may throw an exception.

See Also:

ContentObjectDefinition.setMediaOptions(AttributeValue[]), Constant Field Values

(Published)

Constructor Detail

Media

protected Media(LibrarySession session,
                Long id,
                Long classId,
                S_LibraryObjectData data)
         throws IfsException

Constructs a Media object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

(Published)

Method Detail

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true if the object has a NAME attribute.

Throws:

IfsException - if operation fails.

getDescription

public String getDescription()
                      throws IfsException

Returns the description of this object.

Returns:

The object description

Throws:

IfsException - if the operation fails

(Published)

getTableName

public String getTableName()
                    throws IfsException

Gets the value of the TABLENAME attribute.

The name of the content table is formed by prepending "ODMM_" to this value, uppercased.

Returns:

the value of the TABLENAME attribute

Throws:

IfsException - if the operation fails

(Published)

getColumnName

public String getColumnName()
                     throws IfsException

Gets the value of the COLUMNNAME attribute.

The value of this attribute is the name of the content table column in which content is stored by this Media.

Returns:

the column name

Throws:

IfsException - if the operation fails

(Published)

isReadOnly

public boolean isReadOnly()
                   throws IfsException

Gets the value of the READONLY attribute.

The value of this attribute indicates whether this Media is read-only. Content cannot be stored on or removed from a read-only Media.

Returns:

whether read-only

Throws:

IfsException - if the operation fails

(Published)

getContentIndexProcedure

public String getContentIndexProcedure()
                                throws IfsException

Gets the name of the stored procedure called by Oracle Text to retrieve content, or null for indirect full-text indexing.

Returns:

the procedure name, or null

Throws:

IfsException - if the operation fails

(Published)

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySessionInterface session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find Media instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

public static Media[] findAll(LibrarySession session)
                       throws IfsException

Returns the set of defined Medias.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of Medias; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

public static Media findByName(LibrarySession session,
                               String name)
                        throws IfsException

Returns the a Media matching the specified name.

Parameters:

session - the session context

name - the Media name

Returns:

the Media matching the specified name; or null if there exists no matching Media

Throws:

IfsException - if the operation fails.