oracle.ifs.beans

Class ClassObject

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SchemaObject

oracle.ifs.beans.TieSchemaObject

oracle.ifs.beans.ClassObject

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SchemaObjectInterface, Traceable

public class ClassObject
extends TieSchemaObject

A ClassObject represents a class whose instances are persistently stored and managed by the iFS server.

When installed, iFS creates a number of ClassObjects. Some of these are used internally; others are for commonly-encountered data types in content management applications. A content management application can use these provided ClassObjects, or create its own by subclassing them.

Each ClassObject may define one or more Attributes for its data. In addition to these, a ClassObject inherits its superclass's Attributes.

Any time a ClassObject is created, altered, or removed, the in-progress Transaction is implicitly committed.

Version:

1.0

Author:

David Pitfield

See Also:

ClassObjectDefinition

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ABSTRACT_ATTRIBUTE An indicator of whether this ClassObject is abstract.
static String	BEANCLASSPATH_ATTRIBUTE The fully-qualified classname of the Beans Java class used to represent instances of this ClassObject in the repository SDK.
static String	CLASS_NAME The class name for this class.
static String	CLASSACL_ATTRIBUTE The ClassAccessControlList that determines which users and/or groups can create instances of this ClassObject.
static String	CLASSPOLICYLIST_ATTRIBUTE The set of Policies implicitly applied to all instances of a ClassObject.
static String	DATABASEOBJECTNAME_ATTRIBUTE The base name for database objects used to store data for instances of this ClassObject.
static String	DESCRIPTION_ATTRIBUTE A textual description of this ClassObject.
static String	FINAL_ATTRIBUTE An indicator of whether this ClassObject is final.
protected ClassObject	m_Superclass The Superclass of this CLASSOBJECT.
protected boolean	m_SuperclassResolved Whether the superclass has been resolved.
static String	PARTITIONED_ATTRIBUTE An indicator of whether the database table that stores data for instances of this ClassObject is partitioned.
static String	SELECTORCLASSPATH_ATTRIBUTE The fully-qualified classname of the Beans Java class used to represent instances of this ClassObject in the repository SDK.
static String	SERVERCLASSPATH_ATTRIBUTE The fully-qualified classname of the Server Java class used to represent instances of this ClassObject in the repository service.
static String	SUPERCLASS_ATTRIBUTE The ClassObject that is the superclass of this ClassObject.
static String	UNIQUENAME_ATTRIBUTE A system-set attribute used to ensure each ClassObject has a unique Name.

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	ClassObject(LibrarySession session, Long id, Long classId, S_ClassObjectData data) Internal use only: Constructs a ClassObject.
protected	ClassObject(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a ClassObject.

Method Summary

Modifier and Type	Method and Description
Attribute	addAttribute(AttributeDefinition def) Adds an Attribute to this ClassObject.
protected static ClassObject	constructClassObject(LibrarySession sess, S_LibraryObjectData data) Internal use only: Constructs a ClassObject for the specified data.
protected static Vector	constructClassObjectVector(LibrarySession sess, Vector vector) Internal use only: Converts a vector of S_LibraryObjectDatas to a vector of ClassObjects.
static ClassObject[]	findAll(LibrarySession session) Returns the set of defined ClassObjects.
static ClassObject	findByName(LibrarySession session, String name) Returns the a ClassObject matching the specified name.
Attribute	getAttributeFromLabel(String label) returns the Attribute, based on the specified Attribute Label.
String	getBeanClasspath() Gets the fully-qualified name of the Java class instantiated to represent instances of this ClassObject within a document management application.
Constructor	getBeansConstructor() Internal use only: Gets the four-argument constructor for the Java class returned by getBeansClasspath.
ClassAccessControlList	getClassAcl() Gets the ClassAccessControlList of this ClassObject.
static ClassObject	getClassObjectFromLabel(LibrarySession sess, String label) returns a ClassObject, based on a specified Label.
PolicyList	getClassPolicyList() Gets the ClassPolicyList of this object.
String	getCommonName() Returns the common Name of the ClassObject, preferably in the original mixed case that was used to create it.
String	getDatabaseObjectName() Returns the Database Object Name.
String	getDatabaseTableName() Gets the name of the database table of the class.
String	getDatabaseViewName() Gets the name of the database view of the class.
String	getDefinitionClasspath() Gets the fully-qualified name of the Java class to use as the definition class for this type.
String	getDescription() Returns the description of a Class Object.
ClassObject[]	getDirectSubclasses() Gets the direct subclasses of this ClassObject.
ClassObject	getDirectSubclasses(int index) Gets the specified direct subclass of this ClassObject.
int	getEffectiveClassAttributeIndex(String attributeName) Gets the index of the specified effective Attribute of this ClassObject.
Attribute[]	getEffectiveClassAttributes() Gets the effective Attributes of this ClassObject.
Attribute	getEffectiveClassAttributes(int index) Gets the specified effective Attribute of this ClassObject.
Attribute	getEffectiveClassAttributes(String attributeName) Gets the specified effective Attribute of this ClassObject.
Vector	getEffectiveClassPolicyListElements(String operation) Gets the set of policies, as PolicyListElements, implicitly applied to all instances of this ClassObject for the specified operation.
int	getExtendedClassAttributeIndex(String attributeName) Gets the index of the specified extended Attribute of this ClassObject.
Attribute[]	getExtendedClassAttributes() Gets the extended Attributes of this ClassObject.
Attribute[]	getExtendedClassAttributes(ClassObject superclass) Gets an array of the Attributes that this ClassObject has and that the specified superclass does not have.
Attribute	getExtendedClassAttributes(int index) Gets the specified extended Attribute of this ClassObject.
Attribute	getExtendedClassAttributes(String attributeName) Gets the specified extended Attribute of this ClassObject.
AttributeValue	getInheritedPropertyValue(String name) Gets named property, if any, by searching in the target ClassObject's PropertyBundle, or in one of its superclasses PropertyBundle.
AttributeValue	getInheritedPropertyValue(String name, boolean bypassNulls) Gets named property, if any, by searching in the target ClassObject's PropertyBundle, or in one of its superclasses PropertyBundle.
String	getLabel() returns the Label for this Attribute, based on the Attribute's name and class.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySessionInterface session) Returns the LibraryObjectLookupCache used by find ClassObject instances by name.
String	getSelectorClasspath() Returns the SelectorClassPath Attribute of the Library Object.
String	getServerClasspath() Returns the ServerClassPath Attribute of the Library Object.
ClassObject[]	getSubclasses() Gets the subclasses of this ClassObject.
ClassObject	getSubclasses(int index) Gets the specified subclass of this ClassObject.
ClassObject	getSuperclass() Gets the superclass of this ClassObject.
boolean	isAbstract() Determines if this is an abstract object.
boolean	isAttribute(String attrName) Gets whether this ClassObject has an Attribute with the specified name.
boolean	isDirectSubclassOf(ClassObject classObject) Gets whether this ClassObject is a direct subclass of the specified ClassObject.
boolean	isFinal() Determines if this is object cannot be sub-classed.
boolean	isInstalledClass() Gets whether this class was created as part of the base installation.
boolean	isPartitioned() Determines if this is a partitioned object.
boolean	isSubclassOf(ClassObject classObject) Gets whether this ClassObject is a subclass of the specified ClassObject.
boolean	isVersionable() Gets whether instances of this ClassObject are versionable.
void	putPolicy(Policy policy) Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
void	refreshDependentViews() Refresh any views that are dependent upon this ClassObject or any of its subs.
void	removeAllPolicies() Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
void	removeAttribute(Attribute attribute) Removes an Attribute from this ClassObject.
void	removeAttribute(Attribute attribute, AttributeDefinition def) Removes an attribute from this ClassObject.
void	removePolicy(Policy policy) Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
void	removePolicy(String opname) Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
void	setBeanClasspath(String javaClassName) Sets the fully-qualified name of the Java class instantiated to represent instances of this ClassObject within a document management application.
void	setClassAcl(ClassAccessControlList acl) Sets the ClassAccessControlList of this ClassObject.
void	setClassPolicyList(PolicyList policyList) Sets the ClassPolicyList of this object.
void	setDescription(String description) Sets the description of this ClassObject.
void	setPolicyBundle(PolicyPropertyBundle bundle) Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
void	setSelectorClasspath(String path) Sets the Selector Class Path attribute.
void	setServerClasspath(String path) Sets the Server Class Path attribute.
protected static ClassObject	vectorClassObjectElement(Vector vector, int index) Internal use only: Gets the specified element of a vector of ClassObjects.
static ClassObject[]	vectorToClassObjectArray(Vector vector) Internal use only: Converts a vector of ClassObjects to an a ClassObject array.

Methods inherited from class oracle.ifs.beans.SchemaObject

addCategory, constructSchemaObject, constructSchemaObjectVector, free, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasNameAttribute, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, setActive, 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, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, 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

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

See Also:

Constant Field Values

(Published)

SUPERCLASS_ATTRIBUTE

public static final String SUPERCLASS_ATTRIBUTE

The ClassObject that is the superclass of this ClassObject.

See Also:

Constant Field Values

(Published)

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

A textual description of this ClassObject.

See Also:

Constant Field Values

(Published)

SERVERCLASSPATH_ATTRIBUTE

public static final String SERVERCLASSPATH_ATTRIBUTE

The fully-qualified classname of the Server Java class used to represent instances of this ClassObject in the repository service.

See Also:

Constant Field Values

(Published)

BEANCLASSPATH_ATTRIBUTE

public static final String BEANCLASSPATH_ATTRIBUTE

The fully-qualified classname of the Beans Java class used to represent instances of this ClassObject in the repository SDK.

See Also:

Constant Field Values

(Published)

SELECTORCLASSPATH_ATTRIBUTE

public static final String SELECTORCLASSPATH_ATTRIBUTE

The fully-qualified classname of the Beans Java class used to represent instances of this ClassObject in the repository SDK.

See Also:

Constant Field Values

(Published)

DATABASEOBJECTNAME_ATTRIBUTE

public static final String DATABASEOBJECTNAME_ATTRIBUTE

The base name for database objects used to store data for instances of this ClassObject.

See Also:

Constant Field Values

(Published)

CLASSACL_ATTRIBUTE

public static final String CLASSACL_ATTRIBUTE

The ClassAccessControlList that determines which users and/or groups can create instances of this ClassObject. If a ClassACL is not specified, then any user can create an instance of the ClassObject (unless it is an abstract class).

See Also:

Constant Field Values

(Published)

CLASSPOLICYLIST_ATTRIBUTE

public static final String CLASSPOLICYLIST_ATTRIBUTE

The set of Policies implicitly applied to all instances of a ClassObject.

See Also:

Constant Field Values

(Published)

ABSTRACT_ATTRIBUTE

public static final String ABSTRACT_ATTRIBUTE

An indicator of whether this ClassObject is abstract. Abstract ClassObjects cannot be instantiated.

See Also:

Constant Field Values

(Published)

FINAL_ATTRIBUTE

public static final String FINAL_ATTRIBUTE

An indicator of whether this ClassObject is final. Final ClassObjects cannot be subclassed.

See Also:

Constant Field Values

(Published)

PARTITIONED_ATTRIBUTE

public static final String PARTITIONED_ATTRIBUTE

An indicator of whether the database table that stores data for instances of this ClassObject is partitioned. Currently only PublicObject database tables are partitioned.

See Also:

Constant Field Values

(Published)

UNIQUENAME_ATTRIBUTE

public static final String UNIQUENAME_ATTRIBUTE

A system-set attribute used to ensure each ClassObject has a unique Name.

See Also:

Constant Field Values

(Published)

m_Superclass

protected ClassObject m_Superclass

The Superclass of this CLASSOBJECT.

(Unpublished)

m_SuperclassResolved

protected boolean m_SuperclassResolved

Whether the superclass has been resolved.

(Unpublished)

Constructor Detail

ClassObject

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

Constructs a ClassObject.

Parameters:

session - the session

id - the id

classId - the class id

data - the data

Throws:

IfsException - if the operation fails

(Unpublished)

ClassObject

protected ClassObject(LibrarySession session,
                      Long id,
                      Long classId,
                      S_ClassObjectData data)
               throws IfsException

Internal use only: Constructs a ClassObject.

For internal use only. Do not use this method. To create a new ClassObject, use LibrarySession.createSchemaObject.

Parameters:

session - the session

id - the id

classId - the class id

data - the data

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getCommonName

public String getCommonName()
                     throws IfsException

Returns the common Name of the ClassObject, preferably in the original mixed case that was used to create it.

Override the default implementation in LibraryObject.

Overrides:

getCommonName in class LibraryObject

Returns:

the common name of this object.

Throws:

IfsException - if operation fails.

(Published)

getDefinitionClasspath

public String getDefinitionClasspath()
                              throws IfsException

Gets the fully-qualified name of the Java class to use as the definition class for this type.

Returns:

the fully-qualified name of the definition class

Throws:

IfsException - if the operation fails

(Published)

isInstalledClass

public boolean isInstalledClass()
                         throws IfsException

Gets whether this class was created as part of the base installation.

Returns:

true if created as part of the base installation

Throws:

IfsException - if the operation fails

(Published)

getLabel

public String getLabel()
                throws IfsException

returns the Label for this Attribute, based on the Attribute's name and class. This overrides the method defined in LibraryObject so that the AttributeLabel resource strings can be checked instead of the InstanceLabels that are checked in LibraryObject. If no AttributeLabel is defined, return the Attribute's name.

Overrides:

getLabel in class LibraryObject

Returns:

the label for this object.

Throws:

IfsException - if operation fails.

(Published)

getClassObjectFromLabel

public static ClassObject getClassObjectFromLabel(LibrarySession sess,
                                                  String label)
                                           throws IfsException

returns a ClassObject, based on a specified Label.

Parameters:

sess - The LibrarySession

label - The Label

Returns:

the corresponding ClassObject.

Throws:

IfsException - if operation fails.

(Published)

getAttributeFromLabel

public Attribute getAttributeFromLabel(String label)
                                throws IfsException

returns the Attribute, based on the specified Attribute Label.

Parameters:

label - the Attribute label

Returns:

the corresponding Attribute

Throws:

IfsException - if operation fails.

(Published)

getBeanClasspath

public String getBeanClasspath()
                        throws IfsException

Gets the fully-qualified name of the Java class instantiated to represent instances of this ClassObject within a document management application.

Returns:

the classname

Throws:

IfsException - if the operation fails

(Published)

setDescription

public void setDescription(String description)
                    throws IfsException

Sets the description of this ClassObject.

Parameters:

description - the description

Throws:

IfsException - if the operation fails

(Published)

setBeanClasspath

public void setBeanClasspath(String javaClassName)
                      throws IfsException

Sets the fully-qualified name of the Java class instantiated to represent instances of this ClassObject within a document management application. The service should be restarted after calling this method.

Parameters:

javaClassName - the classname

Throws:

IfsException - if the operation fails

(Published)

setClassPolicyList

public void setClassPolicyList(PolicyList policyList)
                        throws IfsException

Sets the ClassPolicyList of this object.

Parameters:

policyList - the ClassPolicyList

Throws:

IfsException - if the operation fails

(Published)

getClassPolicyList

public PolicyList getClassPolicyList()
                              throws IfsException

Gets the ClassPolicyList of this object.

Returns:

the ClassPolicyList

Throws:

IfsException - if the operation fails

(Published)

getClassAcl

public ClassAccessControlList getClassAcl()
                                   throws IfsException

Gets the ClassAccessControlList of this ClassObject.

Returns:

the ClassAccessControlList

Throws:

IfsException - if the operation fails

(Published)

setClassAcl

public void setClassAcl(ClassAccessControlList acl)
                 throws IfsException

Sets the ClassAccessControlList of this ClassObject.

Parameters:

acl - the ClassAccessControlList

Throws:

IfsException - if the operation fails

(Published)

getEffectiveClassPolicyListElements

public Vector getEffectiveClassPolicyListElements(String operation)
                                           throws IfsException

Gets the set of policies, as PolicyListElements, implicitly applied to all instances of this ClassObject for the specified operation.

The PolicyListElements are returned in SORTSEQUENCE order. If more than one PolicyListElement has a particular SORTSEQUENCE value, a PolicyListElement introduced by a classobject precedes the PolicyListElements introduced by the superclasses of that classobject.

Parameters:

operation - the operation of interest, or null for all operations

Returns:

a Vector of PolicyListElement objects

Throws:

IfsException - if the operation fails

(Published)

setPolicyBundle

public void setPolicyBundle(PolicyPropertyBundle bundle)
                     throws IfsException

Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework

Sets the policy bundle PropertyBundle of this ClassObject.

Overrides:

setPolicyBundle in class SchemaObject

Parameters:

bundle - the policy bundle

Throws:

IfsException - if the operation fails

(Published)

putPolicy

public void putPolicy(Policy policy)
               throws IfsException

Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework

Adds a Policy to the policy bundle PropertyBundle of this ClassObject.

If this ClassObject doesn't have a policy bundle, this method will create one with a Published ACL and default name and description.

Overrides:

putPolicy in class SchemaObject

Parameters:

policy - the Policy to add

Throws:

IfsException - if the operation fails

(Published)

removePolicy

public void removePolicy(String opname)
                  throws IfsException

Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework

Removes a Policy from this ClassObject's policy bundle PropertyBundle.

Overrides:

removePolicy in class SchemaObject

Parameters:

opname - the operation name of the Policy to remove

Throws:

IfsException - if the operation fails

(Published)

removePolicy

public void removePolicy(Policy policy)
                  throws IfsException

Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework

Removes a Policy from this ClassObject's policy bundle PropertyBundle.

This method does not cause a "dedicated" PropertyBundle to be created.

Overrides:

removePolicy in class SchemaObject

Parameters:

policy - the Policy to remove

Throws:

IfsException - if the operation fails

(Published)

removeAllPolicies

public void removeAllPolicies()
                       throws IfsException

Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework

Removes all Policy objects from this ClassObject's policy bundle PropertyBundle, leaving an empty PropertyBundle.

Overrides:

removeAllPolicies in class SchemaObject

Throws:

IfsException - if the operation fails

(Published)

addAttribute

public Attribute addAttribute(AttributeDefinition def)
                       throws IfsException

Adds an Attribute to this ClassObject.

Parameters:

def - the AttributeDefinition of the new Attribute

Returns:

the new Attribute

Throws:

IfsException - (IFS-30820) if the operation fails

(Published)

removeAttribute

public void removeAttribute(Attribute attribute)
                     throws IfsException

Removes an Attribute from this ClassObject.

Parameters:

attribute - the Attribute to remove

Throws:

IfsException - (IFS-30821) if the operation fails

(Published)

removeAttribute

public void removeAttribute(Attribute attribute,
                            AttributeDefinition def)
                     throws IfsException

Removes an attribute from this ClassObject.

Parameters:

attribute - the attribute to remove

def - a definition that influences how the attribute is removed, or null for default behavior

Throws:

IfsException - (IFS-30821) if the operation fails

(Unpublished)

refreshDependentViews

public void refreshDependentViews()
                           throws IfsException

Refresh any views that are dependent upon this ClassObject or any of its subs.

Throws:

IfsException - if the operation fails

(Unpublished)

getEffectiveClassAttributes

public Attribute[] getEffectiveClassAttributes()
                                        throws IfsException

Gets the effective Attributes of this ClassObject.

The effective Attributes of a ClassObject are both the Attributes introduced by the ClassObject itself as well as the Attributes the ClassObject inherits from its superclasses.

Returns:

the Attributes

Throws:

IfsException - if the operation fails

(Published)

getEffectiveClassAttributes

public Attribute getEffectiveClassAttributes(int index)
                                      throws IfsException

Gets the specified effective Attribute of this ClassObject.

The effective Attributes of a ClassObject are both the Attributes introduced by the ClassObject itself as well as the Attributes the ClassObject inherits from its superclasses.

Parameters:

index - the zero-based index

Returns:

the Attribute

Throws:

IfsException - if the operation fails

(Published)

getEffectiveClassAttributes

public Attribute getEffectiveClassAttributes(String attributeName)
                                      throws IfsException

Gets the specified effective Attribute of this ClassObject.

The effective Attributes of a ClassObject are both the Attributes introduced by the ClassObject itself as well as the Attributes the ClassObject inherits from its superclasses.

Parameters:

attributeName - the Attribute name

Returns:

the Attribute, or null if there is no Attribute with the specified name

Throws:

IfsException - if the operation fails

(Published)

getEffectiveClassAttributeIndex

public int getEffectiveClassAttributeIndex(String attributeName)
                                    throws IfsException

Gets the index of the specified effective Attribute of this ClassObject.

The effective Attributes of a ClassObject are both the Attributes introduced by the ClassObject itself as well as the Attributes the ClassObject inherits from its superclasses.

Parameters:

attributeName - the Attribute name

Returns:

the index

Throws:

IfsException - (IFS-10407) if the Attribute name is not the name of an effective Attribute of this ClassObject

IfsException - if the operation otherwise fails

(Unpublished)

getExtendedClassAttributes

public Attribute[] getExtendedClassAttributes()
                                       throws IfsException

Gets the extended Attributes of this ClassObject.

The extended Attributes of a ClassObject are only the Attributes introduced by the ClassObject itself, and do not include any Attributes the ClassObject inherits from its superclasses.

Returns:

the Attributes. If the class has no extended Attributes, an zero-length array is returned.

Throws:

IfsException - if the operation fails

(Published)

getExtendedClassAttributes

public Attribute[] getExtendedClassAttributes(ClassObject superclass)
                                       throws IfsException

Gets an array of the Attributes that this ClassObject has and that the specified superclass does not have.

Parameters:

superclass - a superclass of this ClassObject

Returns:

the Attributes. If this ClassObject has exactly the same Attributes as the specified superclass, a zero-length array is returned.

Throws:

IfsException - (IFS-19001) if superclass is null

IfsException - (IFS-19005) if superclass is not a superclass of this ClassObject

IfsException - if the operation otherwise fails

(Published)

getExtendedClassAttributes

public Attribute getExtendedClassAttributes(int index)
                                     throws IfsException

Gets the specified extended Attribute of this ClassObject.

The extended Attributes of a ClassObject are only the Attributes introduced by the ClassObject itself, and do not include any Attributes the ClassObject inherits from its superclasses.

Parameters:

index - the zero-based index

Returns:

the Attribute

Throws:

IfsException - if the operation fails

(Published)

getExtendedClassAttributes

public Attribute getExtendedClassAttributes(String attributeName)
                                     throws IfsException

Gets the specified extended Attribute of this ClassObject.

The extended Attributes of a ClassObject are only the Attributes introduced by the ClassObject itself, and do not include any Attributes the ClassObject inherits from its superclasses.

Parameters:

attributeName - the Attribute name

Returns:

the Attribute, or null if there is no Attribute with the specified name

Throws:

IfsException - if the operation fails

(Published)

getExtendedClassAttributeIndex

public int getExtendedClassAttributeIndex(String attributeName)
                                   throws IfsException

Gets the index of the specified extended Attribute of this ClassObject.

The extended Attributes of a ClassObject are only the Attributes introduced by the ClassObject itself, and do not include any Attributes the ClassObject inherits from its superclasses.

Parameters:

attributeName - the Attribute name

Returns:

the index

Throws:

IfsException - (IFS-10407) if the Attribute name is not the name of an extended Attribute of this ClassObject

IfsException - if the operation otherwise fails

(Unpublished)

isAttribute

public boolean isAttribute(String attrName)
                    throws IfsException

Gets whether this ClassObject has an Attribute with the specified name.

Parameters:

attrName - the Attribute name

Returns:

whether this ClassObject has an Attribute with that name

Throws:

IfsException - if the operation fails

(Published)

getSuperclass

public ClassObject getSuperclass()
                          throws IfsException

Gets the superclass of this ClassObject.

Returns:

the superclass, or null if this ClassObject has no superclass

Throws:

IfsException - if the operation fails

(Published)

getDirectSubclasses

public ClassObject[] getDirectSubclasses()
                                  throws IfsException

Gets the direct subclasses of this ClassObject.

The direct subclasses are the ClassObjects that directly extend this ClassObject.

Returns:

the subclasses

Throws:

IfsException - if the operation fails

(Published)

getDirectSubclasses

public ClassObject getDirectSubclasses(int index)
                                throws IfsException

Gets the specified direct subclass of this ClassObject.

The direct subclasses are the ClassObjects that directly extend this ClassObject.

Parameters:

index - the zero-based index

Returns:

the subclass

Throws:

IfsException - if the operation fails

(Published)

getSubclasses

public ClassObject[] getSubclasses()
                            throws IfsException

Gets the subclasses of this ClassObject.

The subclasses are the ClassObjects that directly extend this ClassObject and their subclasses, sub-subclasses, etc.

Returns:

the subclasses

Throws:

IfsException - if the operation fails

(Published)

getSubclasses

public ClassObject getSubclasses(int index)
                          throws IfsException

Gets the specified subclass of this ClassObject.

The subclasses are the ClassObjects that directly extend this ClassObject and their subclasses, sub-subclasses, etc.

Parameters:

index - the zero-based index

Returns:

the subclass

Throws:

IfsException - if the operation fails

(Published)

isDirectSubclassOf

public boolean isDirectSubclassOf(ClassObject classObject)
                           throws IfsException

Gets whether this ClassObject is a direct subclass of the specified ClassObject.

Parameters:

classObject - the ClassObject to test

Returns:

whether this ClassObject is a direct subclass of classObject

Throws:

IfsException - (IFS-19001) if classObject is null

(Published)

isSubclassOf

public boolean isSubclassOf(ClassObject classObject)
                     throws IfsException

Gets whether this ClassObject is a subclass of the specified ClassObject.

Parameters:

classObject - the ClassObject to test

Returns:

whether this ClassObject is a subclass of classObject

Throws:

IfsException - (IFS-19001) if classObject is null

(Published)

isVersionable

public boolean isVersionable()
                      throws IfsException

Gets whether instances of this ClassObject are versionable.

Returns:

whether instances of this ClassObject are versionable

Throws:

IfsException - if the operation fails

(Published)

getInheritedPropertyValue

public AttributeValue getInheritedPropertyValue(String name)
                                         throws IfsException

Gets named property, if any, by searching in the target ClassObject's PropertyBundle, or in one of its superclasses PropertyBundle.

Return null if no property exists for this name.

Parameters:

name - the Property name

Returns:

the AttributeValue for the requested property, or null if no specific Proeprty exists on this class or its superclasses.

Throws:

IfsException - if the operation fails

(Published)

getInheritedPropertyValue

public AttributeValue getInheritedPropertyValue(String name,
                                                boolean bypassNulls)
                                         throws IfsException

Gets named property, if any, by searching in the target ClassObject's PropertyBundle, or in one of its superclasses PropertyBundle.

If bypassNulls is true, null valued properties are ignored, and treated the same as if the property was not defined. Return null if no property exists for this name.

Parameters:

name - the Property name

bypassNulls - indication as to whether null valued properties should be treated the same as if the property is not defined

Returns:

the AttributeValue for the requested property, or null if no specific Proeprty exists on this class or its superclasses.

Throws:

IfsException - if the operation fails

(Published)

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySessionInterface session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find ClassObject instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

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

Returns the set of defined ClassObjects.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of ClassObjects; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

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

Returns the a ClassObject matching the specified name.

ClassObject name lookups are case insensitive, so this operation ignores case.

Parameters:

session - the session context

name - the ClassObject name

Returns:

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

Throws:

IfsException - if the operation fails.

constructClassObjectVector

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

Internal use only: Converts a vector of S_LibraryObjectDatas to a vector of ClassObjects.

For internal use only. Do not use this method.

Parameters:

sess - the session

vector - the S_LibraryObjectData vector

Returns:

the ClassObject vector

Throws:

IfsException - if the operation fails

(Unpublished)

constructClassObject

protected static ClassObject constructClassObject(LibrarySession sess,
                                                  S_LibraryObjectData data)
                                           throws IfsException

Internal use only: Constructs a ClassObject for the specified data.

For internal use only. Do not use this method.

Parameters:

sess - the session

data - the data

Returns:

the ClassObject

Throws:

IfsException - if the operation fails

(Unpublished)

vectorToClassObjectArray

public static ClassObject[] vectorToClassObjectArray(Vector vector)

Internal use only: Converts a vector of ClassObjects to an a ClassObject array.

For internal use only. Do not use this method.

Parameters:

vector - the vector

Returns:

the array

(Unpublished)

vectorClassObjectElement

protected static ClassObject vectorClassObjectElement(Vector vector,
                                                      int index)

Internal use only: Gets the specified element of a vector of ClassObjects.

For internal use only. Do not use this method.

Parameters:

vector - the vector

index - the zero-based index

Returns:

the ClassObject

(Unpublished)

getBeansConstructor

public Constructor getBeansConstructor()
                                throws IfsException

Internal use only: Gets the four-argument constructor for the Java class returned by getBeansClasspath.

For internal use only. Do not use this method.

Returns:

the constructor

Throws:

IfsException - if the operation fails

(Unpublished)

getDescription

public String getDescription()
                      throws IfsException

Returns the description of a Class Object.

Returns:

The description of the ClassObject.

Throws:

IfsException - if the operation fails

(Published)

getServerClasspath

public String getServerClasspath()
                          throws IfsException

Returns the ServerClassPath Attribute of the Library Object.

Returns:

The Server Class Path.

Throws:

IfsException - if the operation fails

(Published)

setServerClasspath

public void setServerClasspath(String path)
                        throws IfsException

Sets the Server Class Path attribute.

Parameters:

path - The server class path

Throws:

IfsException - if the operation fails.

(Published)

getSelectorClasspath

public String getSelectorClasspath()
                            throws IfsException

Returns the SelectorClassPath Attribute of the Library Object.

Returns:

The Selector Class Path.

Throws:

IfsException - if the operation fails

(Published)

setSelectorClasspath

public void setSelectorClasspath(String path)
                          throws IfsException

Sets the Selector Class Path attribute.

Parameters:

path - The selector class path

Throws:

IfsException - if the operation fails.

(Published)

getDatabaseObjectName

public String getDatabaseObjectName()
                             throws IfsException

Returns the Database Object Name.

Returns:

The Database Object Name.

Throws:

IfsException - if the operation fails.

(Published)

getDatabaseTableName

public String getDatabaseTableName()
                            throws IfsException

Gets the name of the database table of the class.

Returns:

the table name, or null if tableless

Throws:

IfsException - if the operation fails

(Unpublished)

getDatabaseViewName

public String getDatabaseViewName()
                           throws IfsException

Gets the name of the database view of the class.

Returns:

the view name, or null if tableless

Throws:

IfsException - if the operation fails

(Unpublished)

isAbstract

public boolean isAbstract()
                   throws IfsException

Determines if this is an abstract object.

Returns:

true if the object is abstract.

Throws:

IfsException - if the operation fails.

(Published)

isFinal

public boolean isFinal()
                throws IfsException

Determines if this is object cannot be sub-classed.

Returns:

true if the object is final.

Throws:

IfsException - if the operation fails.

(Published)

isPartitioned

public boolean isPartitioned()
                      throws IfsException

Determines if this is a partitioned object.

Returns:

true if the object is partitioned.

Throws:

IfsException - if the operation fails.

(Unpublished)