wt.fc
Class PagingSession

java.lang.Object
  wt.fc.WTObject
      wt.fc.PagingSession

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class PagingSession

extends WTObject

implements Externalizable

This class represents a persistent paging session. The ObjectIdentifier ID value is used as a paging session ID. The PeristInfo create and update timestamps are used to determine if a paging session has "timed-out" and should be cleaned up.

Use the newPagingSession static factory method(s), not the PagingSession 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

private static String	CLASSNAME
private WTPrincipalReference	creator
static String	CREATOR Label for the attribute; The reference to a persisted principal who created the paging session.
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SESSION_ID Label for the attribute; Identifies the persistent paging session Supported API: false
static String	TOTAL_COUNT Label for the attribute; This number counts how many results has been inserted into PageResults table.
private int	totalCount

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

PagingSession()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
WTPrincipalReference	getCreator() Gets the object for the association that plays role: CREATOR.
long	getSessionId() Gets the value of the attribute: SESSION_ID.
int	getTotalCount() Gets the value of the attribute: TOTAL_COUNT.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static PagingSession	newPagingSession() 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(PagingSession thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCreator(WTPrincipalReference a_Creator) Sets the object for the association that plays role: CREATOR.
void	setTotalCount(int a_TotalCount) Sets the value of the attribute: TOTAL_COUNT.
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 wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

SESSION_ID

public static final String SESSION_ID

Label for the attribute; Identifies the persistent paging session

Supported API: false

See Also:

Constant Field Values

TOTAL_COUNT

public static final String TOTAL_COUNT

Label for the attribute; This number counts how many results has been inserted into PageResults table. The initial value is 0, which means inserting is in the process, and it will be set to a non-negative number when inserting is done, or to negative number if inserting goes wrong.

Supported API: false

See Also:

Constant Field Values

totalCount

private int totalCount

CREATOR

public static final String CREATOR

Label for the attribute; The reference to a persisted principal who created the paging session.

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

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

PagingSession

public PagingSession()

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

Overrides:

writeExternal in class WTObject

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

Overrides:

readExternal in class WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(PagingSession 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

Overrides:

writeExternal in class WTObject

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

Overrides:

readExternal in class WTObject

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

getSessionId

public long getSessionId()

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

Supported API: false

Returns:

long

getTotalCount

public int getTotalCount()

Gets the value of the attribute: TOTAL_COUNT. This number counts how many results has been inserted into PageResults table. The initial value is 0, which means inserting is in the process, and it will be set to a non-negative number when inserting is done, or to negative number if inserting goes wrong.

Supported API: false

Returns:

int

setTotalCount

public void setTotalCount(int a_TotalCount)

Sets the value of the attribute: TOTAL_COUNT. This number counts how many results has been inserted into PageResults table. The initial value is 0, which means inserting is in the process, and it will be set to a non-negative number when inserting is done, or to negative number if inserting goes wrong.

Supported API: false

Parameters:

a_TotalCount -

getCreator

public WTPrincipalReference getCreator()

Gets the object for the association that plays role: CREATOR. The reference to a persisted principal who created the paging session.

Supported API: false

Returns:

WTPrincipalReference

setCreator

public void setCreator(WTPrincipalReference a_Creator)

Sets the object for the association that plays role: CREATOR. The reference to a persisted principal who created the paging session.

Supported API: false

Parameters:

a_Creator -

newPagingSession

public static PagingSession newPagingSession()
                                      throws WTException

Default factory for the class.

Supported API: false

Returns:

PagingSession

Throws:

WTException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class WTObject

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class WTObject

Returns:

int