|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWQuery | +--filenet.vw.api.VWQueueQuery
Use this class to perform queries for queue elements, work objects, or Instruction elements. An instance of this class returns only one type of item. For example, if a query object's next( ) iterator has fetched work objects, an error occurs when next( ) attempts to fetch a different fetchType of query item.
The query ends when next( ) returns null values.
VWQueueQuery implements Iterator methods next() and hasNext(), emulating the new collection model in Java 2.
VWQueue
,
VWQueueElement
,
VWWorkObject
,
VWStepElement
Field Summary | |
static int |
QUERY_GET_TRANSLATED_SYSTEM_FIELDS
|
static int |
QUERY_LOCK_OBJECTS
Value of 16 Flag used to specify that items returned from a query should become locked. |
static int |
QUERY_MAX_VALUES_INCLUSIVE
Value of 64 Flag used to specify that maximum values passed in a query are inclusive, i.e. |
static int |
QUERY_MIN_VALUES_INCLUSIVE
Value of 32 Flag used to specify that minimum values passed in a query are inclusive, i.e. |
static int |
QUERY_READ_BOUND
Value of 2 Flag used to specify that items returned from a query should include those that are already bound to a user or machine. |
static int |
QUERY_READ_LOCKED
Value of 1 Flag used to specify that items returned from a query should include those that are already locked. |
static int |
QUERY_READ_UNWRITABLE
Value of 4 Flag used to specify that items returned from a query should include those that are read-only. |
Method Summary | |
int |
fetchCount()
Gets the integer value indicating the number of records that can be retrieved, using this queueQuery definition. |
VWInstructionElement[] |
fetchInstructionElements(int bufferSize)
Deprecated. Replaced by next() |
VWQueueElement[] |
fetchQueueElements(int bufferSize)
Deprecated. Replaced by next() |
VWWorkObject[] |
fetchWorkObjects(int bufferSize)
Deprecated. Replaced by next() |
int |
getElementType()
Gets the fetch type of this VWQueueQuery object. |
VWQueue |
getQueue()
Gets the queue retrieved by the VWQueue.startQuery() method. |
boolean |
hasNext()
Indicates whether the current VWQueueQuery object contains an element that can be returned by an additional invocation of the next( ) iterator. |
boolean |
isDone()
Deprecated. Replaced by next() |
java.lang.Object |
next()
Retrieves the next queue element. |
void |
resetFetch()
Resets the last element fetched for this queue query object. |
java.lang.String |
toString()
Retrieves a string version of the current query's queue name. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int QUERY_READ_LOCKED
public static final int QUERY_READ_BOUND
public static final int QUERY_READ_UNWRITABLE
public static final int QUERY_LOCK_OBJECTS
public static final int QUERY_MIN_VALUES_INCLUSIVE
public static final int QUERY_MAX_VALUES_INCLUSIVE
public static final int QUERY_GET_TRANSLATED_SYSTEM_FIELDS
Method Detail |
public VWWorkObject[] fetchWorkObjects(int bufferSize) throws VWException
next()
bufferSize
- An integer value specifying the maximum number of Work
Objects to return for each fetch operation. The value must be
greater than zero (0). The server imposes a maximum; therefore,
the number of returned work objects might be smaller than
the number specified here.VWException
- Thrown if it cannot
fetch a specific number of work objects.public VWQueueElement[] fetchQueueElements(int bufferSize) throws VWException
next()
bufferSize
- An integer value specifying the maximum
number of elements to return for each fetch operation. The
value must be greater than zero (0). The server imposes a maximum;
therefore, the number of returned elements might be smaller
than the number specified in the parameter.VWException
- Thrown if it cannot
fetch a specific number of queue elements.public VWInstructionElement[] fetchInstructionElements(int bufferSize) throws VWException
next()
bufferSize
- An integer value specifying the maximum
number of elements to return for each fetch operation. The
value must be greater than zero (0). The server imposes a
maximum; therefore, the number of returned elements might be
smaller than the number specified in the parameter.VWException
- Thrown if it cannot
fetch a specific number of Instruction elements.public VWQueue getQueue()
VWQueue
public boolean isDone()
next()
public java.lang.String toString()
toString
in class java.lang.Object
public void resetFetch()
public int getElementType()
Fetch types are:
If VWFetchType.FETCH_TYPE_NONE (-1) returns, the application used the deprecated VWQueue.startQuery() method to create this object.
public java.lang.Object next() throws VWException
The system retrieves elements from the database in the blocks specified in VWQueue.setBufferSize() and returns them sequentially (one-by-one) to the user. The application queries the server for the next block of data as long as objects matching the specified query exist in the database.
Optimize performance on retrieval from the server by respecifying buffer size with VWQueue and create a new VWQueueQuery object. Before using this method, create the VWQueueQuery object with the VWQueue.startQuery() method, which requires type specification. Set the retrieval buffer size in the VWQueue object before creating the VWQueueQuery object.
VWException
- The method throws an exception if the
application uses the deprecated startQuery() method to create
the VWQueueQuery. An instance of this class returns only one
type of item, and an exception is thrown when next( ) attempts to
fetch a different fetchType of query item.public boolean hasNext() throws VWException
VWException
- The method throws an exception if it cannot
indicate whether the current VWQueueQuery object contains an
element that can be returned by an additional invocation of the
next( ) iterator. Exceptions may be caused by incorrect
createQuery parameters, network errors, data base errors, or
general system errors.public int fetchCount() throws VWException
VWException
- Thrown if it cannot
get the integer value indicating the number of records that can
be retrieved, using this queueQuery object queue. One cause of this
is an incorrect query parameter.
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |