oracle.ifs.beans

Class SchemaCategory

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SchemaObject

oracle.ifs.beans.TieSchemaObject

oracle.ifs.beans.SchemaCategory

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SchemaObjectInterface, Traceable

Direct Known Subclasses:

TieSchemaCategory

public class SchemaCategory
extends TieSchemaObject

A SchemaCategory class is used to add custom meta-data to SchemaObjects on a per instance basis. In addition, Schema Categories can be added across different SchemaObject classes.

SchemaCategory subclasses can contain their own custom data, which effectively contain data about the SchemaObject with which the Category instance is associated. A SchemaObject can be associated with any Category, which allows different sets of data to be associated with instances of the same SchemaObject subclass. Additionally, SchemaObjects can be associated with multiple instances of Category subclasses.

Version:

1.0

Author:

Sirisha Ayyagari

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSOCIATEDSCHEMAOBJECT_ATTRIBUTE The SchemaObject that is associated with this Category.
static String	CLASS_NAME This class name for this class.
static String	DESCRIPTION_ATTRIBUTE The description of this schema category

Fields inherited from class oracle.ifs.beans.SchemaObject

ACTIVE_ATTRIBUTE, NAME_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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SchemaCategory(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a Schema Category object - standard variant.

Method Summary

Modifier and Type	Method and Description
protected static SchemaCategory[]	constructCategoryArray(LibrarySession sess, Long[] ids) Construct a SchemaCategory array from an array of object IDs.
protected static Vector	constructCategoryVector(LibrarySession sess, Vector vector) Returns SchemaCategory Vector from a Vector of SchemaCategory.
protected static SchemaCategory	constructSchemaCategory(LibrarySession sess, S_LibraryObjectData data) Returns a SchemaCategory object from a SchemaCategory data object.
SchemaObject	getAssociatedSchemaObject() Gets the SchemaObject associated with this Category.
String	getDescription() Returns the description of this object
void	setDescription(String description) Updates the description of this object.

Methods inherited from class oracle.ifs.beans.SchemaObject

addCategory, constructSchemaObject, constructSchemaObjectVector, free, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasNameAttribute, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, 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, preCreate, preFree, prePostAuditEvent, preUpdate, 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

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

The description of this schema category

See Also:

Constant Field Values

(Published)

ASSOCIATEDSCHEMAOBJECT_ATTRIBUTE

public static final String ASSOCIATEDSCHEMAOBJECT_ATTRIBUTE

The SchemaObject that is associated with this Category. This allows different sets of data to be associated with instances of the same SchemaObject subclass.

See Also:

Constant Field Values

(Published)

Constructor Detail

SchemaCategory

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

Constructs a Schema Category object - standard variant.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data components

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getDescription

public String getDescription()
                      throws IfsException

Returns the description of this object

Returns:

The object description

Throws:

IfsException - if operation fails.

(Published)

setDescription

public void setDescription(String description)
                    throws IfsException

Updates the description of this object.

Parameters:

description - New description

Throws:

IfsException - if operation fails.

(Published)

getAssociatedSchemaObject

public SchemaObject getAssociatedSchemaObject()
                                       throws IfsException

Gets the SchemaObject associated with this Category.

Returns:

the SchemaObject

Throws:

IfsException - if operation fails

(Published)

constructCategoryVector

protected static Vector constructCategoryVector(LibrarySession sess,
                                                Vector vector)
                                         throws IfsException

Returns SchemaCategory Vector from a Vector of SchemaCategory.

Parameters:

sess - current LibrarySession

vector - Vector of SchemaCategory objects.

Throws:

IfsException - if the operation fails

(Unpublished)

constructSchemaCategory

protected static SchemaCategory constructSchemaCategory(LibrarySession sess,
                                                        S_LibraryObjectData data)
                                                 throws IfsException

Returns a SchemaCategory object from a SchemaCategory data object.

Parameters:

sess - current LibrarySession

data - the object containing SchemaCategory data

Throws:

IfsException - if the operation fails

(Unpublished)

constructCategoryArray

protected static SchemaCategory[] constructCategoryArray(LibrarySession sess,
                                                         Long[] ids)
                                                  throws IfsException

Construct a SchemaCategory array from an array of object IDs. This will throw an exception if any of the IDs cannot be converted into a Category.

Parameters:

sess - the requesting session

ids - the array of object IDs

Returns:

the array of Categorys

Throws:

IfsException - if operation fails.

(Unpublished)