filenet.vw.api

Class VWQueueQuery

  • java.lang.Object
    • filenet.vw.api.VWQueueQuery

    • Method Detail

      • fetchWorkObjects

        public VWWorkObject[] fetchWorkObjects(int bufferSize)
                                throws VWException
        Deprecated. Replaced by VWQueueQuery.next()
        Fetches a specific number of work objects. Call the method once for each work object the query being fetched. If the number of requested elements (specified in the bufferSize parameter) is greater than the number of elements returned in the query, all remaining elements return in a single fetch. An instance of this class returns only one type of item. Therefore, an error occurs if this call follows a call to the deprecated fetchInstructionElements or the fetchQueueElements methods.
        Parameters:
        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.
        Returns:
        An array of VWWorkObjects that represents the fetched items. If no more objects are available to fetch, the method returns a null value.
        Throws:
        VWException - Thrown if it cannot fetch a specific number of work objects.

      • fetchQueueElements

        public VWQueueElement[] fetchQueueElements(int bufferSize)
                                    throws VWException
        Deprecated. Replaced by VWQueueQuery.next()
        Fetches a specific number of queue elements. Call the method once for each queue element being fetched. If the number of requested elements (specified in the bufferSize parameter) is greater than the number of elements returned in the query, all remaining elements return in a single fetch. An instance of this class returns only one type of item. Therefore, an error occurs if this call follows a call to the deprecated fetchInstructionElements or the fetchWorkObjects methods.
        Parameters:
        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.
        Returns:
        An array of VWQueueElement objects that represent the fetched items. If no more objects are available to fetch, the method returns a null value.
        Throws:
        VWException - Thrown if it cannot fetch a specific number of queue elements.

      • fetchInstructionElements

        public VWInstructionElement[] fetchInstructionElements(int bufferSize)
                                                throws VWException
        Deprecated. Replaced by VWQueueQuery.next()
        Fetches a specific number of Instruction elements. Call the method once for each Instruction element being fetched. If the number of requested elements (specified in the bufferSize parameter) is greater than the number of elements returned in the query, all remaining elements return in a single fetch. An instance of this class returns only one type of item. Therefore, an error occurs if this call follows a call to the deprecated fetchQueueElements or the fetchWorkObjects methods.
        Parameters:
        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.
        Returns:
        An array of VWInstructionElement objects that represent the fetched items. If no more objects are available to fetch, the method returns a null value.
        Throws:
        VWException - Thrown if it cannot fetch a specific number of Instruction elements.

      • getQueue

        public VWQueue getQueue()
        Gets the queue retrieved by the VWQueue.createQuery() method or the deprecated VWQueue.startQuery() method.
        Returns:
        A Queue object retrieved by the VWQueue.startQuery() method.
        See Also:
        VWQueue

      • isDone

        public boolean isDone()
        Deprecated. Replaced by VWQueueQuery.next()
        Indicates whether the query completed.
        Returns:
        A Boolean value. The method returns true if no elements to fetch; otherwise, the method returns false, which indicates there are more elements to fetch.

      • toString

        public java.lang.String toString()
        Retrieves a string version of the current query's queue name.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string that contains the name of the queue.

      • resetFetch

        public void resetFetch()
        Resets the last element fetched for this queue query object. New fetch results include previously fetched elements.
        Since:
        VWWS3.10

      • getElementType

        public int getElementType()
        Gets the fetch type of this VWQueueQuery object.
        Returns:
        An integer value indicating the type of the elements.

        Fetch types are:

        • -1: VWFetchType.FETCH_TYPE_NONE
        • 1: VWFetchType.FETCH_TYPE_WORKOBJECT
        • 2: VWFetchType.FETCH_TYPE_INSTRUCTION_ELEMENT
        • 3: VWFetchType.FETCH_TYPE_QUEUE_ELEMENT
        • 5: VWFetchType.FETCH_TYPE_STEP_ELEMENT

        If VWFetchType.FETCH_TYPE_NONE (-1) returns, the application used the deprecated VWQueue.startQuery() method to create this object.

        Since:
        VWWS3.10

      • next

        public java.lang.Object next()
                      throws VWException
        Retrieves the subsequent element for this VWQueueQuery instance. Invoke this method repeatedly to retrieve a series of objects that can be cast to the fetch type of this VWQueueQuery object, as specified by the VWQueue.createQuery(String, Object[], Object[], int, String, Object[], int) call that created this VWQueueQuery instance. Returns null when no more objects can be returned.

        Supports distributed transactions

        To use this method, create a VWQueueQuery object with a VWQueue.createQuery(String, Object[], Object[], int, String, Object[], int) call, which specifies a range of objects to be fetched, a SQL filter expression, and the type of object to be fetched. The resulting query object will use a default buffer size of 50 retrieved items.

        After a set of items in the current retrieval buffer is exhausted, additional items will be retrieved from the Process server and buffered. The effective buffer block size is the lesser of the number specified with a preceding VWQueue.setBufferSize(int) call and the number imposed by the Process server limit.

        You can modify retrieval performance by changing the retrieval buffer size. To change the current retrieval buffer size, set it with a VWQueue.setBufferSize(int) call from the same instance of the VWQueue class that created the current VWQueueQuery object. In other words, after you reset the buffer size, you must create a new VWQueueQuery object (which will contain this next() method) with VWQueue.createQuery(String, Object[], Object[], int, String, Object[], int). In the new instance of VWQueueQuery, the next() method will use the new buffer size.
        Note
        This method requires a buffer size greater than 1 to operate properly.

        Returns:
        An object that represents an item of the fetch type specified in the VWQueue.createQuery(String, Object[], Object[], int, String, Object[], int) method that created the current VWQueueQuery object, or null (indicating there are no more objects in the series).
        Note
        The returned object should be cast to the fetch type specified by the creating VWQueue.createQuery(String, Object[], Object[], int, String, Object[], int) call.
        Throws:
        VWException - Various causes. A possible cause may be using the deprecated VWQueue.startQuery(String, Object[], Object[], int, String, Object[]) method to create the current VWQueueQuery instance, instead of a VWQueue.createQuery(String, Object[], Object[], int, String, Object[], int) call.
        Since:
        VWWS3.10
        See Also:
        VWQueueQuery.hasNext()

      • fetchCount

        public int fetchCount()
               throws VWException
        Gets the integer value indicating the number of records that can be retrieved, using this queueQuery object. Results are approximate because the record set may change before the query returns.
        Returns:
        An integer value indicating the number of records that could be retrieved in the queue, using this VWQueueQuery object queue.
        Throws:
        VWException - Thrown if it cannot get the integer value indicating the number of records that can be retrieved, using this VWQueueQuery object queue. One cause of this is an incorrect query parameter.
        Since:
        VWWS3.10

      • getBufferSize

        public int getBufferSize()
        Gets the maximum number of elements set by the user to return in a fetch. The default value is 50.
        Returns:
        An integer value indicating the maximum number of elements to return in a fetch.
        Since:
        VWWS4.0

      • setBufferSize

        public void setBufferSize(int newSize)
                   throws VWException
        Sets the maximum number of elements to return in a fetch (defaults to 50). The server imposes a maximum limit of 100. The number returned may be smaller if the items are very large.
        Parameters:
        newSize - This must be greater than zero.
        Throws:
        VWException - Thrown if buffer size is less than or equal to 0 (zero).

      • getLastRecord

        public java.lang.String getLastRecord()
        Gets the last record in the query results.
        Returns:
        A base64-encoded String containing the last record of the query results. Null is returned if no last record.
        Since:
        CPE 5.2.0.3

      • setLastRecord

        public void setLastRecord(java.lang.String lastWorkRecStr)
        Set the last record in the query result
        Parameters:
        lastWorkRecStr - A base64-encoded String containing the last record of the query results. If this value is null, the query starts from the beginning.
        Since:
        CPE 5.2.0.3
Skip navigation links
Process API

© Copyright IBM Corporation 2002, 2019. All rights reserved.