oracle.ifs.beans

Class SchemaObjectDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SchemaObjectDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

AttributeDefinition, ClassDomainDefinition, ClassObjectDefinition, SchemaCategoryDefinition, ValueDefaultDefinition, ValueDomainDefinition

public class SchemaObjectDefinition
extends LibraryObjectDefinition

A SchemaObjectDefinition is a template for creating a new SchemaObject.

Version:

1.0

Author:

Simon Wynn

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

Modifier and Type	Field and Description
protected Vector	m_CategoryDefs the Category definition.

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

Method Summary

Modifier and Type	Method and Description
void	addCategoryDefinition(SchemaCategoryDefinition def) Adds a new SchemaCategory Definition to the new SchemaObject.
void	addCategoryDefinitions(SchemaCategoryDefinition[] defs) Adds a set of new Schema Category Definition to the new SchemaObject.
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
SchemaCategoryDefinition[]	getCategoryDefinitions() returns all the Schema CategoryDefinitions for this Definition Return null if no Schema Category definitions exist
void	removeCategoryDefinitions() Removes all Schema CategoryDefinition specifications from this instance.
void	setCategoryDefinitions(SchemaCategoryDefinition[] defs) Defines a set of new Schema Category Definition to the new SchemaObject.
static SchemaObjectDefinition	toSchemaObjectDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a SchemaObjectDefinition.
static SchemaObjectDefinition	toSchemaObjectDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a SchemaObjectDefinition.

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

Field Detail

m_CategoryDefs

protected Vector m_CategoryDefs

the Category definition.

(Unpublished)

Constructor Detail

SchemaObjectDefinition

public SchemaObjectDefinition(LibrarySessionInterface session)
                       throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

SchemaObjectDefinition

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

applySettings

public void applySettings(AttributeValueTable avt)
                   throws IfsException

Applies settings from the specified table.

Overrides:

applySettings in class LibraryObjectDefinition

Parameters:

avt - the table containing the settings

Throws:

IfsException - if the operation fails

(Published)

addCategoryDefinition

public void addCategoryDefinition(SchemaCategoryDefinition def)
                           throws IfsException

Adds a new SchemaCategory Definition to the new SchemaObject.

Parameters:

def - the SchemaCategory definition for the new Category.

Throws:

IfsException

(Published)

addCategoryDefinitions

public void addCategoryDefinitions(SchemaCategoryDefinition[] defs)
                            throws IfsException

Adds a set of new Schema Category Definition to the new SchemaObject. All specified Schema CategoryDefinitions will be added to the current set of definitions held by this instance.

Parameters:

defs - the Schema Category definitions to be added for this instance

Throws:

IfsException

(Unpublished)

setCategoryDefinitions

public void setCategoryDefinitions(SchemaCategoryDefinition[] defs)
                            throws IfsException

Defines a set of new Schema Category Definition to the new SchemaObject. All previously specified Schema CategoryDefinitions will be removed, prior to adding this set to the instance.

Parameters:

defs - the Schema Category definitions for the new Category.

Throws:

IfsException

(Unpublished)

removeCategoryDefinitions

public void removeCategoryDefinitions()
                               throws IfsException

Removes all Schema CategoryDefinition specifications from this instance.

Throws:

IfsException

(Unpublished)

getCategoryDefinitions

public SchemaCategoryDefinition[] getCategoryDefinitions()
                                                  throws IfsException

returns all the Schema CategoryDefinitions for this Definition Return null if no Schema Category definitions exist

Returns:

Schema CategoryDefinitions for this KO Definition

Throws:

IfsException - if the operation fails

(Published)

toSchemaObjectDefinition

public static SchemaObjectDefinition toSchemaObjectDefinition(LibraryObjectDefinition lodef)
                                                       throws IfsException

Cast specified LibraryObjectDefinition to a SchemaObjectDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a SchemaObjectDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toSchemaObjectDefinition

public static SchemaObjectDefinition toSchemaObjectDefinition(LibraryObjectDefinition lodef,
                                                              boolean enforceCompat)
                                                       throws IfsException

Cast specified LibraryObjectDefinition to a SchemaObjectDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a SchemaObjectDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)