wt.fc
Class ExtendedPageResults

java.lang.Object
  wt.fc.ExtendedPageResults

All Implemented Interfaces:

DatastoreElement, DatastoreStruct, Externalizable, NetFactor, ObjectMappable, Serializable

public class ExtendedPageResults

extends Object

implements DatastoreStruct, Externalizable

This class represents the persistent table used for storing extended paging results. Any OID columns that cannot be stored in the primary paging results table are stored here. This class extends ObjectMappable so that introspection information will exist to map attribute names to column names. This class is not Persistable so an external DDL script must exist for creating the table specified by this class.

Use the newExtendedPageResults static factory method(s), not the ExtendedPageResults constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	CLASS_NAME1 Label for the attribute; ObjectIdentifier class name Supported API: false
private static int	CLASS_NAME1_UPPER_LIMIT
static String	CLASS_NAME2 Label for the attribute; ObjectIdentifier class name Supported API: false
private static int	CLASS_NAME2_UPPER_LIMIT
static String	CLASS_NAME3 Label for the attribute; ObjectIdentifier class name Supported API: false
private static int	CLASS_NAME3_UPPER_LIMIT
static String	CLASS_NAME4 Label for the attribute; ObjectIdentifier class name Supported API: false
private static int	CLASS_NAME4_UPPER_LIMIT
static String	CLASS_NAME5 Label for the attribute; ObjectIdentifier class name Supported API: false
private static int	CLASS_NAME5_UPPER_LIMIT
private static String	CLASSNAME
private String	className1
private String	className2
private String	className3
private String	className4
private String	className5
static String[]	CLASSNAMES Array of class attribute class names.
static long	EXTERNALIZATION_VERSION_UID
static int	MAX_OID_COUNT Supported API: false
static String[]	OID_NAMES Array of class attribute oid names.
private long	oid1
static String	OID1 Label for the attribute; ObjectIdentifier ID Supported API: false
private long	oid2
static String	OID2 Label for the attribute; ObjectIdentifier ID Supported API: false
private long	oid3
static String	OID3 Label for the attribute; ObjectIdentifier ID Supported API: false
private long	oid4
static String	OID4 Label for the attribute; ObjectIdentifier ID Supported API: false
private long	oid5
static String	OID5 Label for the attribute; ObjectIdentifier ID Supported API: false
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
static String	ROW_EXTENSION Label for the attribute; Row extension value for a particular paging row Supported API: false
static String	ROW_ORDER Label for the attribute; Row order value from the initial query order Supported API: false
private long	rowExtension
private long	rowOrder
(package private) static long	serialVersionUID
static String	SESSION_ID Label for the attribute; Identifies the paging session Supported API: false
private static int	SESSION_ID_UPPER_LIMIT
private String	sessionId
static String	TABLE_NAME Name of the page results table.

Constructor Summary

ExtendedPageResults()

Method Summary

private void	className1Validate(String a_ClassName1)
private void	className2Validate(String a_ClassName2)
private void	className3Validate(String a_ClassName3)
private void	className4Validate(String a_ClassName4)
private void	className5Validate(String a_ClassName5)
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getClassName1() Gets the value of the attribute: CLASS_NAME1.
String	getClassName2() Gets the value of the attribute: CLASS_NAME2.
String	getClassName3() Gets the value of the attribute: CLASS_NAME3.
String	getClassName4() Gets the value of the attribute: CLASS_NAME4.
String	getClassName5() Gets the value of the attribute: CLASS_NAME5.
String	getConceptualClassname() Deprecated.
long	getOid1() Gets the value of the attribute: OID1.
long	getOid2() Gets the value of the attribute: OID2.
long	getOid3() Gets the value of the attribute: OID3.
long	getOid4() Gets the value of the attribute: OID4.
long	getOid5() Gets the value of the attribute: OID5.
long	getRowExtension() Gets the value of the attribute: ROW_EXTENSION.
long	getRowOrder() Gets the value of the attribute: ROW_ORDER.
String	getSessionId() Gets the value of the attribute: SESSION_ID.
protected void	initialize() Supports initialization, following construction of an instance.
static ExtendedPageResults	newExtendedPageResults() Default factory for the class.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ExtendedPageResults thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	sessionIdValidate(String a_SessionId)
void	setClassName1(String a_ClassName1) Sets the value of the attribute: CLASS_NAME1.
void	setClassName2(String a_ClassName2) Sets the value of the attribute: CLASS_NAME2.
void	setClassName3(String a_ClassName3) Sets the value of the attribute: CLASS_NAME3.
void	setClassName4(String a_ClassName4) Sets the value of the attribute: CLASS_NAME4.
void	setClassName5(String a_ClassName5) Sets the value of the attribute: CLASS_NAME5.
void	setOid1(long a_Oid1) Sets the value of the attribute: OID1.
void	setOid2(long a_Oid2) Sets the value of the attribute: OID2.
void	setOid3(long a_Oid3) Sets the value of the attribute: OID3.
void	setOid4(long a_Oid4) Sets the value of the attribute: OID4.
void	setOid5(long a_Oid5) Sets the value of the attribute: OID5.
void	setRowExtension(long a_RowExtension) Sets the value of the attribute: ROW_EXTENSION.
void	setRowOrder(long a_RowOrder) Sets the value of the attribute: ROW_ORDER.
void	setSessionId(String a_SessionId) Sets the value of the attribute: SESSION_ID.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

TABLE_NAME

public static final String TABLE_NAME

Name of the page results table.

Supported API: false

See Also:

Constant Field Values

SESSION_ID

public static final String SESSION_ID

Label for the attribute; Identifies the paging session

Supported API: false

See Also:

Constant Field Values

SESSION_ID_UPPER_LIMIT

private static int SESSION_ID_UPPER_LIMIT

sessionId

private String sessionId

ROW_ORDER

public static final String ROW_ORDER

Label for the attribute; Row order value from the initial query order

Supported API: false

See Also:

Constant Field Values

rowOrder

private long rowOrder

ROW_EXTENSION

public static final String ROW_EXTENSION

Label for the attribute; Row extension value for a particular paging row

Supported API: false

See Also:

Constant Field Values

rowExtension

private long rowExtension

CLASS_NAME1

public static final String CLASS_NAME1

Label for the attribute; ObjectIdentifier class name

Supported API: false

See Also:

Constant Field Values

CLASS_NAME1_UPPER_LIMIT

private static int CLASS_NAME1_UPPER_LIMIT

className1

private String className1

OID1

public static final String OID1

Label for the attribute; ObjectIdentifier ID

Supported API: false

See Also:

Constant Field Values

oid1

private long oid1

CLASS_NAME2

public static final String CLASS_NAME2

Label for the attribute; ObjectIdentifier class name

Supported API: false

See Also:

Constant Field Values

CLASS_NAME2_UPPER_LIMIT

private static int CLASS_NAME2_UPPER_LIMIT

className2

private String className2

OID2

public static final String OID2

Label for the attribute; ObjectIdentifier ID

Supported API: false

See Also:

Constant Field Values

oid2

private long oid2

CLASS_NAME3

public static final String CLASS_NAME3

Label for the attribute; ObjectIdentifier class name

Supported API: false

See Also:

Constant Field Values

CLASS_NAME3_UPPER_LIMIT

private static int CLASS_NAME3_UPPER_LIMIT

className3

private String className3

OID3

public static final String OID3

Label for the attribute; ObjectIdentifier ID

Supported API: false

See Also:

Constant Field Values

oid3

private long oid3

CLASS_NAME4

public static final String CLASS_NAME4

Label for the attribute; ObjectIdentifier class name

Supported API: false

See Also:

Constant Field Values

CLASS_NAME4_UPPER_LIMIT

private static int CLASS_NAME4_UPPER_LIMIT

className4

private String className4

OID4

public static final String OID4

Label for the attribute; ObjectIdentifier ID

Supported API: false

See Also:

Constant Field Values

oid4

private long oid4

CLASS_NAME5

public static final String CLASS_NAME5

Label for the attribute; ObjectIdentifier class name

Supported API: false

See Also:

Constant Field Values

CLASS_NAME5_UPPER_LIMIT

private static int CLASS_NAME5_UPPER_LIMIT

className5

private String className5

OID5

public static final String OID5

Label for the attribute; ObjectIdentifier ID

Supported API: false

See Also:

Constant Field Values

oid5

private long oid5

OID_NAMES

public static final String[] OID_NAMES

Array of class attribute oid names.

Supported API: false

CLASSNAMES

public static final String[] CLASSNAMES

Array of class attribute class names.

Supported API: false

MAX_OID_COUNT

public static final int MAX_OID_COUNT

Supported API: false

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

ExtendedPageResults

public ExtendedPageResults()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ExtendedPageResults thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getSessionId

public String getSessionId()

Gets the value of the attribute: SESSION_ID. Identifies the paging session

Supported API: false

Returns:

String

setSessionId

public void setSessionId(String a_SessionId)
                  throws WTPropertyVetoException

Sets the value of the attribute: SESSION_ID. Identifies the paging session

Supported API: false

Parameters:

a_SessionId -

Throws:

WTPropertyVetoException

sessionIdValidate

private void sessionIdValidate(String a_SessionId)
                        throws WTPropertyVetoException

Parameters:

a_SessionId -

Throws:

WTPropertyVetoException

getRowOrder

public long getRowOrder()

Gets the value of the attribute: ROW_ORDER. Row order value from the initial query order

Supported API: false

Returns:

long

setRowOrder

public void setRowOrder(long a_RowOrder)
                 throws WTPropertyVetoException

Sets the value of the attribute: ROW_ORDER. Row order value from the initial query order

Supported API: false

Parameters:

a_RowOrder -

Throws:

WTPropertyVetoException

getRowExtension

public long getRowExtension()

Gets the value of the attribute: ROW_EXTENSION. Row extension value for a particular paging row

Supported API: false

Returns:

long

setRowExtension

public void setRowExtension(long a_RowExtension)
                     throws WTPropertyVetoException

Sets the value of the attribute: ROW_EXTENSION. Row extension value for a particular paging row

Supported API: false

Parameters:

a_RowExtension -

Throws:

WTPropertyVetoException

getClassName1

public String getClassName1()

Gets the value of the attribute: CLASS_NAME1. ObjectIdentifier class name

Supported API: false

Returns:

String

setClassName1

public void setClassName1(String a_ClassName1)
                   throws WTPropertyVetoException

Sets the value of the attribute: CLASS_NAME1. ObjectIdentifier class name

Supported API: false

Parameters:

a_ClassName1 -

Throws:

WTPropertyVetoException

className1Validate

private void className1Validate(String a_ClassName1)
                         throws WTPropertyVetoException

Parameters:

a_ClassName1 -

Throws:

WTPropertyVetoException

getOid1

public long getOid1()

Gets the value of the attribute: OID1. ObjectIdentifier ID

Supported API: false

Returns:

long

setOid1

public void setOid1(long a_Oid1)
             throws WTPropertyVetoException

Sets the value of the attribute: OID1. ObjectIdentifier ID

Supported API: false

Parameters:

a_Oid1 -

Throws:

WTPropertyVetoException

getClassName2

public String getClassName2()

Gets the value of the attribute: CLASS_NAME2. ObjectIdentifier class name

Supported API: false

Returns:

String

setClassName2

public void setClassName2(String a_ClassName2)
                   throws WTPropertyVetoException

Sets the value of the attribute: CLASS_NAME2. ObjectIdentifier class name

Supported API: false

Parameters:

a_ClassName2 -

Throws:

WTPropertyVetoException

className2Validate

private void className2Validate(String a_ClassName2)
                         throws WTPropertyVetoException

Parameters:

a_ClassName2 -

Throws:

WTPropertyVetoException

getOid2

public long getOid2()

Gets the value of the attribute: OID2. ObjectIdentifier ID

Supported API: false

Returns:

long

setOid2

public void setOid2(long a_Oid2)
             throws WTPropertyVetoException

Sets the value of the attribute: OID2. ObjectIdentifier ID

Supported API: false

Parameters:

a_Oid2 -

Throws:

WTPropertyVetoException

getClassName3

public String getClassName3()

Gets the value of the attribute: CLASS_NAME3. ObjectIdentifier class name

Supported API: false

Returns:

String

setClassName3

public void setClassName3(String a_ClassName3)
                   throws WTPropertyVetoException

Sets the value of the attribute: CLASS_NAME3. ObjectIdentifier class name

Supported API: false

Parameters:

a_ClassName3 -

Throws:

WTPropertyVetoException

className3Validate

private void className3Validate(String a_ClassName3)
                         throws WTPropertyVetoException

Parameters:

a_ClassName3 -

Throws:

WTPropertyVetoException

getOid3

public long getOid3()

Gets the value of the attribute: OID3. ObjectIdentifier ID

Supported API: false

Returns:

long

setOid3

public void setOid3(long a_Oid3)
             throws WTPropertyVetoException

Sets the value of the attribute: OID3. ObjectIdentifier ID

Supported API: false

Parameters:

a_Oid3 -

Throws:

WTPropertyVetoException

getClassName4

public String getClassName4()

Gets the value of the attribute: CLASS_NAME4. ObjectIdentifier class name

Supported API: false

Returns:

String

setClassName4

public void setClassName4(String a_ClassName4)
                   throws WTPropertyVetoException

Sets the value of the attribute: CLASS_NAME4. ObjectIdentifier class name

Supported API: false

Parameters:

a_ClassName4 -

Throws:

WTPropertyVetoException

className4Validate

private void className4Validate(String a_ClassName4)
                         throws WTPropertyVetoException

Parameters:

a_ClassName4 -

Throws:

WTPropertyVetoException

getOid4

public long getOid4()

Gets the value of the attribute: OID4. ObjectIdentifier ID

Supported API: false

Returns:

long

setOid4

public void setOid4(long a_Oid4)
             throws WTPropertyVetoException

Sets the value of the attribute: OID4. ObjectIdentifier ID

Supported API: false

Parameters:

a_Oid4 -

Throws:

WTPropertyVetoException

getClassName5

public String getClassName5()

Gets the value of the attribute: CLASS_NAME5. ObjectIdentifier class name

Supported API: false

Returns:

String

setClassName5

public void setClassName5(String a_ClassName5)
                   throws WTPropertyVetoException

Sets the value of the attribute: CLASS_NAME5. ObjectIdentifier class name

Supported API: false

Parameters:

a_ClassName5 -

Throws:

WTPropertyVetoException

className5Validate

private void className5Validate(String a_ClassName5)
                         throws WTPropertyVetoException

Parameters:

a_ClassName5 -

Throws:

WTPropertyVetoException

getOid5

public long getOid5()

Gets the value of the attribute: OID5. ObjectIdentifier ID

Supported API: false

Returns:

long

setOid5

public void setOid5(long a_Oid5)
             throws WTPropertyVetoException

Sets the value of the attribute: OID5. ObjectIdentifier ID

Supported API: false

Parameters:

a_Oid5 -

Throws:

WTPropertyVetoException

newExtendedPageResults

public static ExtendedPageResults newExtendedPageResults()
                                                  throws WTException

Default factory for the class.

Supported API: false

Returns:

ExtendedPageResults

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Throws:

WTException