oracle.ifs.beans

Class ClassObjectDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SchemaObjectDefinition

oracle.ifs.beans.ClassObjectDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ClassObjectDefinition
extends SchemaObjectDefinition

The ClassObjectDefinition class is used to construct an ClassObject.

This subclass of SchemaObjectDefinition sets the default ClassObject to "CLASSOBJECT".

Version:

2.0

Author:

Dave Long, David Pitfield

See Also:

ClassObject, 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
static String	DROP_TABLE_SYSTEMOPTION_NAME The name of the system option whose boolean AttributeValue controls whether, in freeing a ClassObject, the base table is dropped.

Fields inherited from class oracle.ifs.beans.SchemaObjectDefinition

m_CategoryDefs

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
ClassObjectDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
ClassObjectDefinition(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	addAttributeDefinition(AttributeDefinition def) Adds an Attribute definition for the new ClassObject.
void	addAttributeDefinitions(AttributeDefinition[] defs) Adds a set of new Attribute definitions.
AttributeDefinition[]	getAttributeDefinitions() Gets the Attributes defined for this instance.
ClassObject	getSuperclass() Deprecated. CM SDK 10gR2: use getAttribute(ClassObject.SUPERCLASS_ATTRIBUTE)
boolean	getTablelessOption() Return the indication as to whether the ClassObject will be created without its own table.
AttributeValue	getUniqueNameValue() Get the value set for the UniqueName.
void	removeAttributeDefinitions() Removes all Attribute definition specifications from this instance.
void	setAttributeDefinitions(AttributeDefinition[] defs) Defines a set of new Attribute Definitions.
void	setName(String name) Sets the name of the new ClassObject.
void	setSuperclass(ClassObject superclass) Deprecated. CM SDK 10gR2: use setAttribute(ClassObject.SUPERCLASS_ATTRIBUTE, AttributeValue.newAttributeValue(superclass));
void	setTablelessOption(boolean option) Set or clear the indication to create the ClassObject without its own table.
void	setUniqueNameValue(AttributeValue av) Set the value set for the UniqueName.

Methods inherited from class oracle.ifs.beans.SchemaObjectDefinition

addCategoryDefinition, addCategoryDefinitions, applySettings, getCategoryDefinitions, removeCategoryDefinitions, setCategoryDefinitions, toSchemaObjectDefinition, toSchemaObjectDefinition

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

DROP_TABLE_SYSTEMOPTION_NAME

public static final String DROP_TABLE_SYSTEMOPTION_NAME

The name of the system option whose boolean AttributeValue controls whether, in freeing a ClassObject, the base table is dropped.

The default behavior is to drop the table. However, if this system option is set false in the ClassObjectDefinition supplied in freeing a ClassObject, the repository will not drop the table. In that case, the caller should ensure the table is dropped by some other means.

See Also:

Constant Field Values

(Unpublished)

Constructor Detail

ClassObjectDefinition

public ClassObjectDefinition(LibrarySessionInterface session)
                      throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

ClassObjectDefinition

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

setName

public final void setName(String name)
                   throws IfsException

Sets the name of the new ClassObject.

Overrides:

setName in class LibraryObjectDefinition

Parameters:

name - the name

Throws:

IfsException - if the operation fails

(Unpublished)

setSuperclass

@Deprecated
public final void setSuperclass(ClassObject superclass)
                                      throws IfsException

Deprecated. CM SDK 10gR2: use setAttribute(ClassObject.SUPERCLASS_ATTRIBUTE, AttributeValue.newAttributeValue(superclass));

Sets the superclass of the new ClassObject.

Parameters:

superclass - the superclass

Throws:

IfsException - if the operation fails

(Published)

getSuperclass

@Deprecated
public final ClassObject getSuperclass()
                                             throws IfsException

Deprecated. CM SDK 10gR2: use getAttribute(ClassObject.SUPERCLASS_ATTRIBUTE)

Gets the superclass of the new ClassObject.

Returns:

the superclass

Throws:

IfsException - if the operation fails

(Published)

addAttributeDefinition

public final void addAttributeDefinition(AttributeDefinition def)
                                  throws IfsException

Adds an Attribute definition for the new ClassObject.

Parameters:

def - the AttributeDefinition

Throws:

IfsException - if the operation fails

(Published)

addAttributeDefinitions

public void addAttributeDefinitions(AttributeDefinition[] defs)
                             throws IfsException

Adds a set of new Attribute definitions. All specified AttributeDefinition will be added to the current set of definitions held by this instance.

Parameters:

defs - the Attribute definitions to be added for this instance

Throws:

IfsException

(Unpublished)

setAttributeDefinitions

public void setAttributeDefinitions(AttributeDefinition[] defs)
                             throws IfsException

Defines a set of new Attribute Definitions. All previously specified AttributeDefinitions will be removed, prior to adding this set to the instance.

Parameters:

defs - the Attribute definitions

Throws:

IfsException

(Unpublished)

removeAttributeDefinitions

public void removeAttributeDefinitions()
                                throws IfsException

Removes all Attribute definition specifications from this instance.

Throws:

IfsException

(Unpublished)

getAttributeDefinitions

public final AttributeDefinition[] getAttributeDefinitions()
                                                    throws IfsException

Gets the Attributes defined for this instance.

Returns:

the AttributeDefinitions

Throws:

IfsException - if the operation fails

(Published)

setUniqueNameValue

public void setUniqueNameValue(AttributeValue av)
                        throws IfsException

Set the value set for the UniqueName.

Parameters:

av - the UniqueName value to be set for this ClassObject

Throws:

IfsException - if the operation fails

(Unpublished)

getUniqueNameValue

public AttributeValue getUniqueNameValue()
                                  throws IfsException

Get the value set for the UniqueName.

Returns:

the UniqueName value to be set for this ClassObject

Throws:

IfsException - if the operation fails

(Unpublished)

setTablelessOption

public void setTablelessOption(boolean option)
                        throws IfsException

Set or clear the indication to create the ClassObject without its own table.

Parameters:

option - true if the ClassObject is to be without its own table

Throws:

IfsException - if operation fails.

(Published)

getTablelessOption

public boolean getTablelessOption()
                           throws IfsException

Return the indication as to whether the ClassObject will be created without its own table.

Returns:

true if the ClassObject is to be without its own table

Throws:

IfsException - if operation fails.

(Published)