oracle.ifs.common

Class ClassInfoTable

java.lang.Object

oracle.ifs.common.ClassInfoTable

All Implemented Interfaces:

Serializable

public class ClassInfoTable
extends Object
implements Serializable

A ClassInfoTable class is used as a Collection-like class for quick lookup of ClassObject info, accessible both bean and server side.

The main difference between this class and Collection classes is that this class does not use PreparedSelectors internally - which creates a problem with the introduction of the "Smart Views" option which now needs basic class info to resolve PreparedSelector data structures, which would result in infinite recursion if it relied on Collections.

Author:

Dave Long

See Also:

Serialized Form

(Published)

Method Summary

Modifier and Type	Method and Description
static ClassInfoTable	build(S_LibrarySession session) Construct a class info table.
AttributeValueTable	getAttributeValueTable() Gets the encapsulated AttributeValueTable.
String	getClassObjectDatabaseObjectName(LibrarySessionInterface session, String className) Gets the ClassObject database obejct name by its class name.
String	getClassObjectDatabaseObjectName(String className) Gets the ClassObject database obejct name by its class name.
Long	getClassObjectId(LibrarySessionInterface session, String className) Gets the ClassObject ID by name.
Long	getClassObjectId(String className) Gets the ClassObject ID by name.
String	getClassObjectTable(LibrarySessionInterface session, String className) Gets the ClassObject table by its name.
String	getClassObjectTable(String className) Gets the ClassObject table by its name.
AttributeValue	getClassObjectValue(LibrarySessionInterface session, String className) Gets an AttributeValue representation of a CLASSOBJECT that has the specified name.
AttributeValue	getClassObjectValue(String className) Gets an AttributeValue representation of a CLASSOBJECT that has the specified name.
String	getClassObjectView(LibrarySessionInterface session, String className) Gets the ClassObject view by its name.
String	getClassObjectView(String className) Gets the ClassObject view by its name.
boolean	isClassObjectPublic(LibrarySessionInterface session, String className) Lookup the ClassObject's "is this a PublicObject subclass" indication using the specified ClassInfo table anbd class name.
boolean	isClassObjectPublic(String className) Lookup the ClassObject's "is this a PublicObject subclass" indication using the specified ClassInfo table anbd class name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAttributeValueTable

public AttributeValueTable getAttributeValueTable()
                                           throws IfsException

Gets the encapsulated AttributeValueTable.

Returns:

a copy of the encapsulated AttributeValueTable

Throws:

IfsException - if the operation fails

(Unpublished)

getClassObjectValue

public AttributeValue getClassObjectValue(String className)
                                   throws IfsException

Gets an AttributeValue representation of a CLASSOBJECT that has the specified name.

Will return null if no ClassObject exists with this name.

Parameters:

className - ClassObject name

Returns:

the CLASSOBJECT value

Throws:

IfsException - if the operation fails

(Published)

getClassObjectValue

public AttributeValue getClassObjectValue(LibrarySessionInterface session,
                                          String className)
                                   throws IfsException

Gets an AttributeValue representation of a CLASSOBJECT that has the specified name.

Will return null if no ClassObject exists with this name.

Parameters:

session - session context

className - ClassObject name

Returns:

the CLASSOBJECT value

Throws:

IfsException - if the operation fails

(Published)

getClassObjectId

public Long getClassObjectId(String className)
                      throws IfsException

Gets the ClassObject ID by name.

Will return null if no ClassObject exists with this name.

Parameters:

className - ClassObject name

Returns:

the ID of the corresponding ClassObject, or null if no ClassObject exists with that name

Throws:

IfsException - if operation fails.

(Published)

getClassObjectId

public Long getClassObjectId(LibrarySessionInterface session,
                             String className)
                      throws IfsException

Gets the ClassObject ID by name.

Will return null if no ClassObject exists with this name.

Parameters:

session - session context

className - ClassObject name

Returns:

the ID of the corresponding ClassObject, or null if no ClassObject exists with that name

Throws:

IfsException - if operation fails.

(Published)

isClassObjectPublic

public boolean isClassObjectPublic(String className)
                            throws IfsException

Lookup the ClassObject's "is this a PublicObject subclass" indication using the specified ClassInfo table anbd class name.

Parameters:

className - ClassObject name

Returns:

true if a ClassObject exists with that name and if the corresponding ClassObject is a subclass of PublicObject; false otherwise

Throws:

IfsException - if operation fails.

(Published)

isClassObjectPublic

public boolean isClassObjectPublic(LibrarySessionInterface session,
                                   String className)
                            throws IfsException

Lookup the ClassObject's "is this a PublicObject subclass" indication using the specified ClassInfo table anbd class name.

Parameters:

session - session context

className - ClassObject name

Returns:

true if a ClassObject exists with that name and if the corresponding ClassObject is a subclass of PublicObject; false otherwise

Throws:

IfsException - if operation fails.

(Published)

getClassObjectTable

public String getClassObjectTable(String className)
                           throws IfsException

Gets the ClassObject table by its name.

Will return null if no ClassObject exists with this name.

Parameters:

className - ClassObject name

Returns:

the ClassObject table, or null if no ClassObject exists with that name

Throws:

IfsException - if operation fails.

(Published)

getClassObjectTable

public String getClassObjectTable(LibrarySessionInterface session,
                                  String className)
                           throws IfsException

Gets the ClassObject table by its name.

Will return null if no ClassObject exists with this name.

Parameters:

session - session context

className - ClassObject name

Returns:

the ClassObject table, or null if no ClassObject exists with that name

Throws:

IfsException - if operation fails.

(Published)

getClassObjectView

public String getClassObjectView(String className)
                          throws IfsException

Gets the ClassObject view by its name.

Will return null if no ClassObject exists with this name.

Parameters:

className - ClassObject name

Returns:

the ClassObject view, or null if no ClassObject exists with that name

Throws:

IfsException - if operation fails.

(Published)

getClassObjectView

public String getClassObjectView(LibrarySessionInterface session,
                                 String className)
                          throws IfsException

Gets the ClassObject view by its name.

Will return null if no ClassObject exists with this name.

Parameters:

session - session context

className - ClassObject name

Returns:

the ClassObject view, or null if no ClassObject exists with that name

Throws:

IfsException - if operation fails.

(Published)

getClassObjectDatabaseObjectName

public String getClassObjectDatabaseObjectName(String className)
                                        throws IfsException

Gets the ClassObject database obejct name by its class name.

Will return null if no ClassObject exists with this name.

Parameters:

className - ClassObject name

Returns:

the ClassObject database obejct name, or null if no ClassObject exists with that name

Throws:

IfsException - if operation fails.

(Published)

getClassObjectDatabaseObjectName

public String getClassObjectDatabaseObjectName(LibrarySessionInterface session,
                                               String className)
                                        throws IfsException

Gets the ClassObject database obejct name by its class name.

Will return null if no ClassObject exists with this name.

Parameters:

session - session context

className - ClassObject name

Returns:

the ClassObject database obejct name, or null if no ClassObject exists with that name

Throws:

IfsException - if operation fails.

(Published)

build

public static ClassInfoTable build(S_LibrarySession session)
                            throws IfsException

Construct a class info table.

Parameters:

session - the session context

Returns:

the class info table

Throws:

IfsException - if the operation fails

(Published)