VWFetchType (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWFetchType

```
public final class VWFetchType
extends java.lang.Object
```
Use this class to determine the fetch type and retrieve a string version of the type.
Call the VWQueue.createQuery() or VWRoster.createQuery() methods and pass the following integer values to get the localized string version for the following fetch types:
- 1: Work object (FETCH_TYPE_WORKOBJECT)
- 2: Instruction element (FETCH_TYPE_INSTRUCTION_ELEMENT)
- 3: Queue element (FETCH_TYPE_QUEUE_ELEMENT)
- 4: Roster (FETCH_TYPE_ROSTER_ELEMENT)
- 5: Step element (FETCH_TYPE_STEP_ELEMENT)
Since:

VWWS3.10

See Also:

VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int), VWRosterQuery, VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int), VWQueueQuery

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FETCH_TYPE_INSTRUCTION_ELEMENT` Value of 2. Return instruction elements by passing the integer as a parameter in the VWQueue.createQuery() method.
`static int`	`FETCH_TYPE_QUEUE_ELEMENT` Value of 3. Return queue elements by passing the integer as a parameter in the VWQueue.createQuery() method.
`static int`	`FETCH_TYPE_ROSTER_ELEMENT` Value of 4. Return roster elements by passing the integer as a parameter in the VWRoster.createQuery() method.
`static int`	`FETCH_TYPE_STEP_ELEMENT` Value of 5. Return step elements by passing the integer as a parameter in the VWQueue.createQuery() method.
`static int`	`FETCH_TYPE_WORKOBJECT` Value of 1. Return work items by passing the integer as a parameter in the VWQueue.createQuery() or VWRoster.createQuery() methods.

Constructor Summary

Constructors
Constructor and Description

VWFetchType()

Constructors
Constructor and Description
`VWFetchType()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getLocalizedString(int fetchType)` Gets the localized fetch type description.
`static boolean`	`isValid(int fetchType)` Determines if the specified integer value is valid.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FETCH_TYPE_WORKOBJECT
```
public static final int FETCH_TYPE_WORKOBJECT
```
    Value of 1. Return work items by passing the integer as a parameter in the VWQueue.createQuery() or VWRoster.createQuery() methods.
    
    See Also:
    
    Constant Field Values
  - FETCH_TYPE_INSTRUCTION_ELEMENT
```
public static final int FETCH_TYPE_INSTRUCTION_ELEMENT
```
    Value of 2. Return instruction elements by passing the integer as a parameter in the VWQueue.createQuery() method.
    
    See Also:
    
    Constant Field Values
  - FETCH_TYPE_QUEUE_ELEMENT
```
public static final int FETCH_TYPE_QUEUE_ELEMENT
```
    Value of 3. Return queue elements by passing the integer as a parameter in the VWQueue.createQuery() method.
    
    See Also:
    
    Constant Field Values
  - FETCH_TYPE_ROSTER_ELEMENT
```
public static final int FETCH_TYPE_ROSTER_ELEMENT
```
    Value of 4. Return roster elements by passing the integer as a parameter in the VWRoster.createQuery() method.
    
    See Also:
    
    Constant Field Values
  - FETCH_TYPE_STEP_ELEMENT
```
public static final int FETCH_TYPE_STEP_ELEMENT
```
    Value of 5. Return step elements by passing the integer as a parameter in the VWQueue.createQuery() method.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VWFetchType
```
public VWFetchType()
```
- Method Detail
  - isValid
```
public static boolean isValid(int fetchType)
```
    Determines if the specified integer value is valid.
    
    Parameters:
    
    fetchType - An integer value associated with the available, well-known fetch types.
    
    Returns:
    
    True-a Boolean value. The method returns true if the integer value specified in the fetchType parameter is valid; otherwise the method returns false.
  - getLocalizedString
```
public static java.lang.String getLocalizedString(int fetchType)
                                           throws VWException
```
    Gets the localized fetch type description.
    
    Parameters:
    
    fetchType - An integer value associated with the fetch type.
    
    Returns:
    
    The localized description string associated with the fetch type.
    
    Throws:
    
    VWException - The method throws an exception if the integer value specified in the fetchType parameter is not valid.

Methods inherited from class java.lang.Object

FETCH_TYPE_WORKOBJECT

FETCH_TYPE_INSTRUCTION_ELEMENT

FETCH_TYPE_QUEUE_ELEMENT

FETCH_TYPE_ROSTER_ELEMENT

FETCH_TYPE_STEP_ELEMENT

VWFetchType

isValid

getLocalizedString