Process Class Relationships

filenet.vw.api
Class VWQueue

java.lang.Object
  |
  +--filenet.vw.api.VWPersistentCollection
        |
        +--filenet.vw.api.VWQueue

public final class VWQueue
extends filenet.vw.api.VWPersistentCollection

Use this class to access the contents of a queue. Specify which part of the queue contents you wish to access by the input of search criteria to parameters of the createQuery() method or the deprecated startQuery() method. Use other methods to obtain specific information about a queue ( like the depth and search fields ).

The VWSession.getQueue() method creates an instance of the VWQueue class.

See Also:
VWSession, VWQueueStats, VWQueueQuery, VWQueueDefinition, createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)

Field Summary
static int QUERY_GET_NO_SYSTEM_FIELDS
          Integer value of 1024. Include this value in the queryFlags parameter of the createQuery() method of the startQuery() method to return objects without system fields.
static int QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS
          Integer value of 2048. Include this value in the queryFlags parameter of the createQuery() method of the deprecated startQuery() method to return objects without translated fields.
static int QUERY_GET_SYSTEM_FIELDS
          Deprecated. Not replaced. This is the default.
static int QUERY_GET_TRANSLATED_SYSTEM_FIELDS
          Deprecated. Not replaced. This is the default.
static int QUERY_LOCK_OBJECTS
          Integer value of 16. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to lock the work items returned from a search.
static int QUERY_MAX_VALUES_INCLUSIVE
          Integer value of 64. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to include maximum search values.
static int QUERY_MIN_VALUES_INCLUSIVE
          Integer value of 32. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to include minimum search values.
static int QUERY_NO_OPTIONS
          Integer value of 0. Pass this value as the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to use the no search options option.
static int QUERY_READ_BOUND
          Integer value of 2. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to return work items that are bound to a user or machine.
static int QUERY_READ_LOCKED
          Integer value of 1. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to return locked and unlocked work items.
static int QUERY_READ_UNWRITABLE
          Integer value of 4. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to return writable and unwritable work items.
static int QUEUE_TYPE_PROCESS
          Integer value of 1. This value is returned by the getQueueType() method to indicate that the queue is a process queue.
static int QUEUE_TYPE_SYSTEM
          Integer value of 3. This value is returned by the getQueueType method to indicate that the queue is a system queue.
static int QUEUE_TYPE_USER_CENTRIC
          Integer value of 2. This value is returned by the getQueueType method to indicate that the queue is a user queue.
 
Method Summary
 java.lang.String convertOperationIdToName(int theOperationId)
          Converts an Operation ID to a name, using the name/ID pair in the current workspace.
 int convertOperationNameToId(java.lang.String theOperationName)
          Converts an Operation name to an ID, using the name/ID pair in the current workspace.
 VWQueueQuery createQuery(java.lang.String indexName, java.lang.Object[] minValues, java.lang.Object[] maxValues, int queryFlags, java.lang.String filter, java.lang.Object[] substitutionVars, int fetchType)
          Fetches queue items.
 int fetchCount()
          Gets the integer value indicating the queue depth.
 java.lang.String[] fetchIndexFields()
          Deprecated. Replaced by fetchQueueDefinition()
 java.lang.String[] fetchIndexKeyFields(java.lang.String indexField)
          Deprecated. Replaced by fetchQueueDefinition()
 java.lang.String[] fetchOperationNames()
          Fetches the list of all the Operation names for this queue.
 VWQueueDefinition fetchQueueDefinition()
          Fetches the definition for this queue.
 java.lang.String[] fetchQueueFields()
          Deprecated. Replaced by fetchQueueDefinition()
 VWQueueStats fetchStatistics(java.util.Date startTime, java.util.Date endTime, int timeUnits)
          Fetches statistical information for the queue, given a start and stop time.
 int getBufferSize()
          Gets the maximum number of elements set by the user to return in a fetch.
 int getCount()
          Deprecated. Replaced by fetchCount()
 int getQueueType()
          Gets an integer value indicating the queue type.
 VWSession getServiceSession()
          Identifies the session that instantiated the search object.
 void setBufferSize(int theNewSize)
          Sets the maximum number of elements to return in a fetch.
 VWQueueQuery startQuery(java.lang.String indexName, java.lang.Object[] minValues, java.lang.Object[] maxValues, int queryFlags, java.lang.String filter, java.lang.Object[] substitutionVars)
          Deprecated. Replaced by createQuery( String, Object[], Object[], int, String, Object[], int).
Note Differences between the use of createQuery() and the deprecated startQuery() method include the following:

  • createQuery() uses a fetchType input parameter.
  • createQuery()'s resultant query object uses iterator methods VWQueueQuery.next() and VWQueueQuery.hasNext(), emulating the Collection Model in Java 2+.
  • Warning You cannot use iterator methods next() or hasNext() on a VWQueueQuery object instantiated by the deprecated startQuery() method--the iterator methods throw an exception if you do.

 java.lang.String toString()
          Gets the string version of the queue name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

QUERY_NO_OPTIONS

public static final int QUERY_NO_OPTIONS
Integer value of 0. Pass this value as the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to use the no search options option.

After passing this value, the returned work items are unlocked, unbound, and writable.


QUERY_READ_LOCKED

public static final int QUERY_READ_LOCKED
Integer value of 1. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to return locked and unlocked work items.

You can use this flag value in conjunction with other flag values. For example, QUERY_READ_LOCKED + QUERY_READ_BOUND returns work items that are locked and bound to a user or machine.


QUERY_READ_BOUND

public static final int QUERY_READ_BOUND
Integer value of 2. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to return work items that are bound to a user or machine.

QUERY_READ_UNWRITABLE

public static final int QUERY_READ_UNWRITABLE
Integer value of 4. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to return writable and unwritable work items. Not setting this flag value specifies the return of only writable work items.

QUERY_LOCK_OBJECTS

public static final int QUERY_LOCK_OBJECTS
Integer value of 16. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to lock the work items returned from a search.

The application locks any work item that meets search criteria. Do not set this flag value to leave unlocked work items unlocked, and avoid specifying QUERY_LOCK_OBJECTS + QUERY_READ_LOCKED.


QUERY_MIN_VALUES_INCLUSIVE

public static final int QUERY_MIN_VALUES_INCLUSIVE
Integer value of 32. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to include minimum search values. Minimum search values are can be the default "greater than" or "greater than or equal to".

QUERY_MAX_VALUES_INCLUSIVE

public static final int QUERY_MAX_VALUES_INCLUSIVE
Integer value of 64. Include this value in the queryFlags parameter of the createQuery() method or the deprecated startQuery() method to include maximum search values. Maximum search values can be the default "less than" or "less than or equal to".

QUERY_GET_SYSTEM_FIELDS

public static final int QUERY_GET_SYSTEM_FIELDS
Deprecated. Not replaced. This is the default.

Integer value of 256. Include this value in the queryFlags parameter of the createQuery() method of the startQuery() method to return system field names and values.

This value MUST be added to the queryFlags variable for this option to take effect with createQuery(), but it is included by default for startQuery().

Use the system fields for additional queries on objects. A method that requires translation returns a default value (NULL, 0, or false). Helper methods require the QUERY_GET_TRANSLATED_SYSTEM_FIELDS to function properly.


QUERY_GET_TRANSLATED_SYSTEM_FIELDS

public static final int QUERY_GET_TRANSLATED_SYSTEM_FIELDS
Deprecated. Not replaced. This is the default.

Integer value of 512. Include this value in the queryFlags parameter of the createQuery() method of the deprecated startQuery() method to return system field names and translated system field values. This value MUST be added to the queryFlags variable for this option to take effect with createQuery(), but it is included by default for startQuery(). Use system fields in the helper methods for each element.

QUERY_GET_NO_SYSTEM_FIELDS

public static final int QUERY_GET_NO_SYSTEM_FIELDS
Integer value of 1024. Include this value in the queryFlags parameter of the createQuery() method of the startQuery() method to return objects without system fields.

System fields and translated system fields are used in the helper methods for each element. System fields and translated system field data will not be returned on the objects queried. A method that requires translation returns a default value (null, 0, or false) for this flag. This is because related Helper methods require the System fields and translated fields to function properly.


QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS

public static final int QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS
Integer value of 2048. Include this value in the queryFlags parameter of the createQuery() method of the deprecated startQuery() method to return objects without translated fields. Use for performance enhancement when methods on retrieved object are not needed and only the returned data itself is needed.

Translated system fields are used in the helper methods for each element. System fields and translated system field data will not be returned on the objects queried. A method that requires translation returns a default value (null, 0, or false) for this flag. This is because related Helper methods require the System fields and translated fields to function properly.


QUEUE_TYPE_PROCESS

public static final int QUEUE_TYPE_PROCESS
Integer value of 1. This value is returned by the getQueueType() method to indicate that the queue is a process queue. A process queue holds objects that an external workflow will process.

QUEUE_TYPE_USER_CENTRIC

public static final int QUEUE_TYPE_USER_CENTRIC
Integer value of 2. This value is returned by the getQueueType method to indicate that the queue is a user queue. A user queue is the queue associated with user; it is similar to the inbox for a user.

QUEUE_TYPE_SYSTEM

public static final int QUEUE_TYPE_SYSTEM
Integer value of 3. This value is returned by the getQueueType method to indicate that the queue is a system queue.
Method Detail

getQueueType

public int getQueueType()
                 throws VWException
Gets an integer value indicating the queue type. Queue type integer values are as follows:


Returns:
An integer value indicating the type of the queue.
Throws:
VWException - The method returns an exception if the queue type cannot be determined.

getCount

public int getCount()
             throws VWException
Deprecated. Replaced by fetchCount()

Gets the integer value indicating the depth.
Returns:
An integer value indicating the current depth of the queue.
Throws:
VWException - The method throws an exception if a problem occurred while determining the queue depth.

fetchCount

public int fetchCount()
               throws VWException
Gets the integer value indicating the queue depth.
Returns:
An integer value indicating the current depth of the queue.
Throws:
VWException - The method throws an exception if a problem occurred while determining the queue depth.
Since:
VWWS3.10

startQuery

public VWQueueQuery startQuery(java.lang.String indexName,
                               java.lang.Object[] minValues,
                               java.lang.Object[] maxValues,
                               int queryFlags,
                               java.lang.String filter,
                               java.lang.Object[] substitutionVars)
                        throws VWException
Deprecated. Replaced by createQuery( String, Object[], Object[], int, String, Object[], int).
Note Differences between the use of createQuery() and the deprecated startQuery() method include the following:

  • createQuery() uses a fetchType input parameter.
  • createQuery()'s resultant query object uses iterator methods VWQueueQuery.next() and VWQueueQuery.hasNext(), emulating the Collection Model in Java 2+.
  • Warning You cannot use iterator methods next() or hasNext() on a VWQueueQuery object instantiated by the deprecated startQuery() method--the iterator methods throw an exception if you do.

The search conditions you specifiy in the parameters of this method cause the retrieval of queue items based on a filter condition and a range in a search index.

Use the following to limit your search:

A queue item must match all fetch criteria specified in the parameters to return successfully.

Parameters:
indexName - The name of the database search index for the queue. Enter either the name assigned to the index at the Configuration Console (this may be a user-defined search field, a system search field, or both) or a name that is a system search field.

The standard system search fields for queues are listed below:

  • F_WobNum: work item number of type byte[]. For MS SQL, pass the hex version of the field value; for example, if F_WobNum were C4BCB36717A2D3119E0F00C04F8C7570, pass 0xC4BCB36717A2D3119E0F00C04F8C7570.
  • F_SortRule: predefined as F_Locked(type integer).
  • F_FiFo: defined to an internal value. Do not modify.

minValues - An array of minimum values with which to compare the index fields.

The type of the array elements must correspond to the field types in the search index. If the number of minValues array elements is smaller than the number of search fields, the application assumes that the fields at the end of the search index have no value. The array element must be of a Java type that corresponds to a Process type. For example, java.lang.Integer would correspond to integer.

In another example, the index named 'myIndex' is an integer, followed by a string, followed by a boolean, followed by a float, followed by a time-type value:

     myIndex = integerA + stringB + booleanC + floatD + timeE
     

Set sample minimum values, against which to compare the index, as follows:

     Object[] minValues = {new Integer(1000), "aardvark",
    new Boolean(true), new Float(0012345678.369), new Time( [date&time value] )}
maxValues - An array of maximum values with which to compare the index fields.

The type of the array elements must correspond to the field types in the search index. If the number of maxValues array elements is smaller than the number of search fields, the application assumes that the fields at the end of the search index have no value. The array element must be of a Java type that corresponds to a Process type(like java.lang.Integer, which corresponds to Process integer).

queryFlags - An integer value used to specify the search option. Setting this parameter refines the search for the work items specified by the search index. Use | and + operators to combine the options. See the Field Detail section for description of these query flags:

  • 0: No query options.(QUERY_NO_OPTIONS)
  • 1: Read and lock (QUERY_READ_LOCKED)
  • 2: Read and bind (QUERY_READ_BOUND)
  • 4: Read-only (QUERY_READ_UNWRITABLE)
  • 16: Lock (QUERY_LOCK_OBJECTS)
  • 32: Include minValues value (QUERY_MIN_VALUE_INCLUSIVE)
  • 64: Include maxValues value (QUERY_MAX_VALUE_INCLUSIVE)

filter - A string containing a SQL statement that specifies a filter condition (for use with values input to the substitutionVars parameter)

Use this parameter with the parameter settings for minValues, maxValues, and queryFlags to refine the search. Input an SQL where-clause that contains a search field name on the left side of a boolean operator and a substitution placeholder on the right side of the operator.

For example: if the filter input is similar to the following SQL statements:

    integerA < :A AND stringB =:A

This filter requires that the object return only if it meets two conditions:

  • The integer, integerA, must be less than the value of the placeholder, A.
  • The string, stringB, must be equal to the value of the placeholder, A.

In the SQL statement, a colon (:) precedes each placeholder on the right side of the statement.

A search field must be a variable or a system or user-defined field. Use of the filter requires substitution of the placeholder to the right of each colon with a corresponding value you input to the substitutionVars parameter.

substitutionVars - An array of objects that contain the values to substitute for the variable names to the right of the colons in the SQL statement you passed to the filter parameter.

A substitution variable must begin with colon. If there is no variable in the filter parameter, the values for this parameter can be null. The array elements in this parameter substitute for the corresponding array elements in the filter parameter array. The filter parameter array elements act as place holders and must be substituted. For example, if three names are :A, a user needs three distinct substitution variables.

In another example, if you pass the following to the substitutionVars parameter:

    {new Integer(1000),"Smith"}

This parameter, in combination with the example parameter for filter input, will pass an object through the filter only when the following condition are met by the object:

    integerA < 1000 AND stringB = "Smith"

Returns:
A VWQueueQuery object from which items are fetched.
Throws:
VWException - Thrown if it cannot create a VWQueueQuery object.

createQuery

public VWQueueQuery createQuery(java.lang.String indexName,
                                java.lang.Object[] minValues,
                                java.lang.Object[] maxValues,
                                int queryFlags,
                                java.lang.String filter,
                                java.lang.Object[] substitutionVars,
                                int fetchType)
                         throws VWException
Fetches queue items. The search conditions you specify in the method parameters retrieve queue items based on the entered filter condition and the specified range in a search index.

Use the following to limit your search:

A queue item must match all fetch criteria specified in the parameters to return successfully.

Parameters:

indexName - The name of the database search index for the queue. Enter either the name assigned to the index at the Configuration Console (this may be a user-defined search field, a system search field, or both) or a name that is a system search field.

The standard system search fields for queues are listed below:

  • F_WobNum: work item number of type byte[]. For MS SQL, pass the hex version of the field value; for example, if F_WobNum were C4BCB36717A2D3119E0F00C04F8C7570, pass 0xC4BCB36717A2D3119E0F00C04F8C7570.
  • F_SortRule: predefined as F_Locked (type integer)
  • F_FiFo: defined to an internal value. Do not modify.

minValues - An array of objects containing the minimum values with which to compare the index fields.

The type of the array elements must correspond to the field types in the search index. If the number of minValues array elements is smaller than the number of search fields, the application assumes that the fields at the end of the search index have no value. Each array element must be of a Java type that corresponds to a Process type; for example, java.lang.Integer, which corresponds to integer.

In another example, the index named 'myIndex' is an integer, followed by a string, followed by a boolean, followed by a float, followed by a time-type value:

     myIndex = integerA + stringB + booleanC + floatD + timeE
     

Set sample minimum values, against which to compare the inde x, as follows:

     Object[] minValues = {new Integer(1000), "aardvark",
    new Boolean(true), new Float(0012345678.369), new Time( [date&time value] )}
maxValues - An array of objects containing the maximum values with which to compare the index fields.

The type of the array elements must correspond to the field types in the search index. If the number of maxValues array elements is smaller than the number of search fields, the application assumes that the fields at the end of the search index have no value. The array element must be of a Java type that corresponds to a Process type; for example, java.lang.Integer, which corresponds to integer.

queryFlags - An integer value that specifies the search options.

An integer value used to specify the search option. Setting the parameter refines the search for the work items specified by the search index. Use | and + operators to combine the options. See the Field Detail section for descriptions of these query flags:

  • 0: Return work objects are unlocked, unbound, and writable. No lock is performed. (QUERY_NO_OPTIONS)
  • 1: Include locked work items. (QUERY_READ_LOCKED)
  • 2: Include work items bound to another user or machine. (QUERY_READ_BOUND)
  • 4: Include work items to which that are not currently writable for this user or machine.
  • 16: Lock the returned work items (use with caution). (QUERY_LOCK_OBJECTS)
  • 32: Include work items matching the minValues value. (QUERY_MIN_VALUE_INCLUSIVE)
  • 64: Include work items matching maxValues value. (QUERY_MAX_VALUE_INCLUSIVE)

filter - A string containing a SQL statement that specifies a filter conditions(used with values input to the substitutionVars parameter).

Use this parameter with the parameter settings for minValues, maxValues, and queryFlags to refine the search. Input a SQL where-clause containing a search field name on the left side of a boolean operator and a substitution placeholder on the right side of the operator.

Example:
Consider a filter parameter that is the following SQL where clause:

    integerA < :A AND stringB =:B

This filter specifies that the object passes the filter only if it meets two conditions:

  1. The integer, integerA, must be less than the value of the placeholder, A.
  2. The string, stringB, must be equal to the value of the next placeholder, B.

The following usage tips summarize the use of this parameter:

  • In a SQL statement, a colon (:) precedes each placeholder variable on the right side of the statement.
  • The search field is a variable or a system- or user-defined field.
  • The operation of the filter causes substitution of the placeholder named to the right of each colon with a value you specify in corresponding order. There ordered values are in the substitutionVars parameter.

substitutionVars - An array of objects that contain the values to substitute for the variable names to the right of the colons in the SQL statement you passed to the filter parameter.

In accordance with SQL expression rules, a substitution variable begins with a colon, and the name itself immediately follows the colon. If there is no such substitution variable in the filter parameter, the values for the substitutionVars parameter will be ignored and can be null. The array elements in this parameter substitute for the corresponding substitution variable elements in the filter parameter array.

The filter parameter array elements contain ordered values that are substituted in order into the corresponding SQL substitution variables, which act as placeholders. For example, if three names are :A, a user needs three distinct substitution variables, and the values are assigned according to the ordered correspondences between the values of the substitutionVars parameter and the occurence of SQL substitution variables in the filter parameter expression that is contained in the filter parameter.

Example:
If you pass the following for the substitutionVars parameter:

    {new Integer(1000),"Smith"}

If this substitutionVars parameter accompanies the above example for the filter parameter input, the object has to meet the following conditions to pass the filter:

    integerA < 1000 AND stringB = "Smith"

The line above is the result of the ordered substitution of substitutionVars values into the SQL filter expression found in the filter parameter.

fetchType - An integer value associated with the element type being to be retrieved using the object returned by VWQueueQuery. Valid element type values are as follows:

  • 1: Work object (FETCH_TYPE_WORKOBJECT)
  • 2: Instruction element (FETCH_TYPE_INSTRUCTION_ELEMENT)
  • 3: Queue element (FETCH_TYPE_QUEUE_ELEMENT)
  • 5: Step element (FETCH_TYPE_STEP_ELEMENT)

Returns:
VWQueueQuery A VWQueueQuery object for the queue from which items are fetched, using a next() iterator, in accord with the Collection Model in Java 2.

A user must have access to the queue to fetch work items (with the FETCH_TYPE_WORKOBJECT value) or queue elements (with the FETCH_TYPE_QUEUE_ELEMENT value). However, users may fetch their own instruction elements or step elements, regardless of access to the queue.

Throws:
VWException - The method throws an exception if it cannot create a VWQueueQuery object.

getServiceSession

public VWSession getServiceSession()
Identifies the session that instantiated the search object.
Overrides:
getServiceSession in class filenet.vw.api.VWPersistentCollection
Returns:
A VWSession object that instantiated the object.

fetchQueueDefinition

public VWQueueDefinition fetchQueueDefinition()
                                       throws VWException
Fetches the definition for this queue. The queue definition contains search fields, search indexes, security information, and the server location of the queue.
Returns:
A VWQueueDefinition object for the queue.
Throws:
VWException - The method throws an exception if it cannot fetch the definition for this queue.
Since:
VWWS3.10

fetchQueueFields

public java.lang.String[] fetchQueueFields()
                                    throws VWException
Deprecated. Replaced by fetchQueueDefinition()

Fetches the user-defined search fields for a specified queue.
Returns:
A string containing an array of search index fields.
Throws:
VWException - The method throws an exception if it cannot fetch the user-defined search fields for a specified queue.

fetchIndexFields

public java.lang.String[] fetchIndexFields()
                                    throws VWException
Deprecated. Replaced by fetchQueueDefinition()

Fetches the user-defined index names for a specified queue.
Returns:
A string containing an array of search index fields.
Throws:
VWException - The method throws an exception if it cannot Fetch the user-defined index names for a specified queue.

fetchIndexKeyFields

public java.lang.String[] fetchIndexKeyFields(java.lang.String indexField)
                                       throws VWException
Deprecated. Replaced by fetchQueueDefinition()

Fetches the ordered fields of a user-defined search index, given a search field name. The order determines which field the application uses in the primary sort, each subsequent field being less significant than the previous.
Parameters:
indexFieldName - The name of the user-defined search field(for example, F_WobNum, F_SortRule, and F_Fifo are system fields.)
Returns:
An ordered array of fields in the search index.
Throws:
VWException - The method throws an exception if the search field does not exist.

fetchStatistics

public VWQueueStats fetchStatistics(java.util.Date startTime,
                                    java.util.Date endTime,
                                    int timeUnits)
                             throws VWException
Fetches statistical information for the queue, given a start and stop time.
Parameters:
startTime - A date value indicating the time to start gathering statistics.
endTime - A date value indicating the time to stop gathering statistics.
timeUnits - An integer value indicating the unit of time for gathering statistics. Valid integer values for associated with the time units are as follows:

  • 1: Minute
  • 2: Hour
  • 3: Day
  • 4: Week
  • 5: Month
  • 6: Year

Returns:
A VWQueueStats statistical results object for queue statistics.
Throws:
VWException - The method throws an exception if it cannot instantiate VWQueueStats statistical results object.
Since:
VWWS3.10
See Also:
VWTimeUnitType.MINUTES, VWTimeUnitType.HOURS, VWTimeUnitType.DAYS, VWTimeUnitType.WEEKS, VWTimeUnitType.MONTHS, VWTimeUnitType.YEARS

toString

public java.lang.String toString()
Gets the string version of the queue name.
Overrides:
toString in class java.lang.Object
Returns:
The queue name.

setBufferSize

public void setBufferSize(int theNewSize)
                   throws VWException
Sets the maximum number of elements to return in a fetch. The default value is 50.
Parameters:
newSize - An integer value used to set maximum number of elements to return in the fetch. The valuemust be greater than zero (0).
Throws:
VWException - The method throws an exception if the buffer size specified in the theNewSize parameter is less than or equal to zero (0).
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:
VWWS3.10

convertOperationNameToId

public int convertOperationNameToId(java.lang.String theOperationName)
                             throws VWException
Converts an Operation name to an ID, using the name/ID pair in the current workspace.

The application makes a remote procedure call (an RPC) if there was no previous server call to get Operation name/ID pairs. If no Operation name is found, the application makes another RPC to retrieve an updated list. If, after the second RPC, the application finds no Operation name, an exception occurs.

Results may be incorrect if the application has deleted Operations from the original Work Performer Class in the current workspace.

Parameters:
theOperationName - The operation name the workflow author configured for this queue.
Returns:
An integer value for the Operation ID that the application can use for a search.
Throws:
VWException - The method throws an exception if it cannot converts an Operation name to an ID.
Since:
VWWS3.10

convertOperationIdToName

public java.lang.String convertOperationIdToName(int theOperationId)
                                          throws VWException
Converts an Operation ID to a name, using the name/ID pair in the current workspace.

The application makes a remote procedure call (an RPC) if there was no previous server call to get Operation name. If no Operation name is found, the application makes another RPC to retrieve an updated list. If, after the second RPC, the application finds no Operation name, an exception occurs.

Results may be incorrect if the application has deleted Operations from the original Work Performer Class in the current workspace.

Parameters:
theOperationId - An integer value for the Operation ID associated with the queue.
Returns:
The string of the Operation name.
Throws:
VWException - Thrown if the application does not find the Operation name or if it cannot convert an Operation ID to a name.
Since:
VWWS3.10

fetchOperationNames

public java.lang.String[] fetchOperationNames()
                                       throws VWException
Fetches the list of all the Operation names for this queue.
Returns:
A string containing an array of Operation names.
Throws:
VWException - The method throws an exception if it cannot fetch the list of all the Operation names for this queue.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.