wt.epm.structure
Class EPMRecursiveResultSet

java.lang.Object
  wt.epm.structure.EPMRecursiveResultSet

All Implemented Interfaces:

Externalizable, Serializable

public final class EPMRecursiveResultSet

extends Object

implements Externalizable

The EPMRecursiveResultSet contains the results of a recursive structure query.

It can represent

An EPMDocumentMaster An EPMDocument

The QueryResult contains the results of the next level of query. Each entry in the QueryResult is another EPMRecursiveResultSet containing a child node of the EPMDocument represented by this EPMRecursiveResultSet.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private EPMDocument	document
static long	EXTERNALIZATION_VERSION_UID
private EPMMemberLink	link
private EPMDocumentMaster	master
protected static long	OLD_FORMAT_VERSION_UID
private QueryResult	queryResult
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

EPMRecursiveResultSet()


Supported API: true

EPMRecursiveResultSet(EPMDocumentMaster master)


Supported API: true

EPMRecursiveResultSet(EPMDocumentMaster master, EPMDocument document)


Supported API: true

EPMRecursiveResultSet(EPMRecursiveResultSet copyFrom)


Supported API: true

Method Summary

EPMDocument	getDocument() Gets the value of the attribute: document.
EPMMemberLink	getLink() Gets the value of the attribute: link; The EPMMemberLink connecting to the EPMDocument or EMFamilyInstance represented by this EPMRecursiveResultSet.
EPMDocumentMaster	getMaster() Gets the value of the attribute: master; The EPMDocuemnt Supported API: false
QueryResult	getQueryResult() Gets the value of the attribute: queryResult.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
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(EPMRecursiveResultSet thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDocument(EPMDocument a_Document) Sets the value of the attribute: document.
void	setLink(EPMMemberLink a_Link) Sets the value of the attribute: link; The EPMMemberLink connecting to the EPMDocument or EMFamilyInstance represented by this EPMRecursiveResultSet.
void	setMaster(EPMDocumentMaster a_Master) Sets the value of the attribute: master; The EPMDocuemnt Supported API: false
void	setQueryResult(QueryResult a_QueryResult) Sets the value of the attribute: queryResult.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

master

private EPMDocumentMaster master

document

private EPMDocument document

queryResult

private QueryResult queryResult

link

private EPMMemberLink link

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

EPMRecursiveResultSet

public EPMRecursiveResultSet(EPMDocumentMaster master)

Supported API: true

Parameters:

master -

EPMRecursiveResultSet

public EPMRecursiveResultSet(EPMDocumentMaster master,
                             EPMDocument document)

Supported API: true

Parameters:

master -

document -

EPMRecursiveResultSet

public EPMRecursiveResultSet()

Supported API: true

EPMRecursiveResultSet

public EPMRecursiveResultSet(EPMRecursiveResultSet copyFrom)

Supported API: true

Parameters:

copyFrom -

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(EPMRecursiveResultSet 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

getMaster

public EPMDocumentMaster getMaster()

Gets the value of the attribute: master; The EPMDocuemnt

Supported API: false

Returns:

EPMDocumentMaster

setMaster

public void setMaster(EPMDocumentMaster a_Master)
               throws WTPropertyVetoException

Sets the value of the attribute: master; The EPMDocuemnt

Supported API: false

Parameters:

a_Master -

Throws:

WTPropertyVetoException

getDocument

public EPMDocument getDocument()

Gets the value of the attribute: document.

Supported API: false

Returns:

EPMDocument

setDocument

public void setDocument(EPMDocument a_Document)
                 throws WTPropertyVetoException

Sets the value of the attribute: document.

Supported API: false

Parameters:

a_Document -

Throws:

WTPropertyVetoException

getQueryResult

public QueryResult getQueryResult()

Gets the value of the attribute: queryResult.

Supported API: false

Returns:

QueryResult

setQueryResult

public void setQueryResult(QueryResult a_QueryResult)
                    throws WTPropertyVetoException

Sets the value of the attribute: queryResult.

Supported API: false

Parameters:

a_QueryResult -

Throws:

WTPropertyVetoException

getLink

public EPMMemberLink getLink()

Gets the value of the attribute: link; The EPMMemberLink connecting to the EPMDocument or EMFamilyInstance represented by this EPMRecursiveResultSet.

This field is only filled in if the query was done with onlyOtherSide == false.

Supported API: false

Returns:

EPMMemberLink

setLink

public void setLink(EPMMemberLink a_Link)
             throws WTPropertyVetoException

Sets the value of the attribute: link; The EPMMemberLink connecting to the EPMDocument or EMFamilyInstance represented by this EPMRecursiveResultSet.

This field is only filled in if the query was done with onlyOtherSide == false.

Supported API: false

Parameters:

a_Link -

Throws:

WTPropertyVetoException