com.ptc.windchill.upgrade.dust
Interface PagingIteratorIfc

All Superinterfaces:
Iterator
All Known Implementing Classes:
PagingIteratorImpl

public interface PagingIteratorIfc
extends Iterator

The PDS paging API is available to release 6.0 and later versions of Windchill. For earlier releases, use a simplied version of paging provided by this tool. In addition to this, PagingIterator also hides the fact that paging is occuring, i.e. the program using this class acts as though it is iterating through a simple ResultSet without bothering with the details of paging.


Method Summary
 void cleanup()
          Clears out the previous query without starting a new one.
 long getSessionId()
          The initial query stores OIDs in a temp table.
 int getTotalSize()
          Returns the number of rows in the temp table for this session id.
 void resetQuery(long session_id, String class_name)
          Clears out the previous query and starts a new paging query with the given QuerySpec.
 
Methods inherited from interface java.util.Iterator
hasNext, next, remove
 

Method Detail

getTotalSize

public int getTotalSize()
Returns the number of rows in the temp table for this session id.


getSessionId

public long getSessionId()
The initial query stores OIDs in a temp table. The session id distinguishes this query's data from another session's.


resetQuery

public void resetQuery(long session_id,
                       String class_name)
                throws WTException
Clears out the previous query and starts a new paging query with the given QuerySpec.

Throws:
WTException

cleanup

public void cleanup()
             throws WTException
Clears out the previous query without starting a new one.

Throws:
WTException