|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWLogQuery
public final class VWLogQuery
Use this class to query for log elements.
The class implements the next() and hasNext() methods to iteratively search, similar to the Java 2 collection model. The query ends when either method returns a null value.
VWLog
,
VWLogElement
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
int |
fetchCount()
Gets the integer value indicating the number of records that can be retrieved, using this logQuery definition. |
VWLog |
getLog()
Gets the log retrieved by the VWLog.startQuery() method. |
boolean |
hasNext()
Determines whether or not more elements exist beyond the current element. |
VWLogElement |
next()
Gets the next log element in the collection (if one exists). |
void |
resetFetch()
Resets the last element fetched for the log query object. |
java.lang.String |
toString()
Gets the string version of the name of the log the query retrieved. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public VWLogElement next() throws VWException
Call the method repeatedly, once for each log element you require from the query. When there are no more log elements available, the method returns null.
The system retrieves elements from the database in blocks of the size you specify in VWLog.setBufferSize() method. Items return one-by-one to the user via this method. If the application requests more items, this API queries the server for the next block of data. An element returns as long as there is an object in the database that matches the specified query conditions.
Respecify buffer size with VWLog and create a new VWLogQuery
object to optimize performance during retrieval from the server.
VWException
- The method throws an exception if it
cannot get the next existing log element in the collection.public VWLog getLog()
public java.lang.String toString()
toString
in class java.lang.Object
public void resetFetch()
public boolean hasNext() throws VWException
VWException
public int fetchCount() throws VWException
VWException
- The method throws an exception if it cannot
get the integer value indicating the number of records that can
be retrieved, using this logQuery definition. One cause of this is
an incorrect query parameter.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |