VWTimeUnitType (Process API Documentation)

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

```
public final class VWTimeUnitType
extends java.lang.Object
```
Use this class to define the time unit types used in computing statistical results.

Since:

VWWS3.10

See Also:

VWStatistics, VWRosterStats, VWQueueStats

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DAYS` Value of 3. Specifies days as the time unit.
`static int`	`HOURS` Value of 2. Specifies hours as the time unit.
`static int`	`MINUTES` Value of 1. Specifies minutes the time unit.
`static int`	`MONTHS` Value of 5. Specifies months as the time unit.
`static int`	`WEEKS` Value of 4. Specifies weeks as the time unit.
`static int`	`YEARS` Value of 6. Specifies years as the time unit.

Constructor Summary

Constructors
Constructor and Description

VWTimeUnitType()

Constructors
Constructor and Description
`VWTimeUnitType()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getLocalizedString(int timeUnitType)` Gets a localized String representation of the time unit type.
`static boolean`	`isValid(int timeUnitType)` Checks that a time unit type is within a valid range.

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

- Field Detail
  - MINUTES
```
public static final int MINUTES
```
    Value of 1. Specifies minutes the time unit.
    
    See Also:
    
    Constant Field Values
  - HOURS
```
public static final int HOURS
```
    Value of 2. Specifies hours as the time unit.
    
    See Also:
    
    Constant Field Values
  - DAYS
```
public static final int DAYS
```
    Value of 3. Specifies days as the time unit.
    
    See Also:
    
    Constant Field Values
  - WEEKS
```
public static final int WEEKS
```
    Value of 4. Specifies weeks as the time unit.
    
    See Also:
    
    Constant Field Values
  - MONTHS
```
public static final int MONTHS
```
    Value of 5. Specifies months as the time unit.
    
    See Also:
    
    Constant Field Values
  - YEARS
```
public static final int YEARS
```
    Value of 6. Specifies years as the time unit.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VWTimeUnitType
```
public VWTimeUnitType()
```
- Method Detail
  - isValid
```
public static boolean isValid(int timeUnitType)
```
    Checks that a time unit type is within a valid range.
    Parameters:
    timeUnitType - An integer value specifying the time unit type value to be validated. Valid time unit values are as follows:
    
    1: Minutes
    2: Hours
    3: Days
    4: Weeks
    5: Months
    6: Years
    Returns:
    
    true if the value specified in the timeUnitType parameter is valid; otherwise, returns false.
  - getLocalizedString
```
public static java.lang.String getLocalizedString(int timeUnitType)
                                           throws VWException
```
    Gets a localized String representation of the time unit type.
    Parameters:
    timeUnitType - An integer value specifying the time unit type value to be represented by a string. Valid time unit values are as follows:
    
    1: Minutes
    2: Hours
    3: Days
    4: Weeks
    5: Months
    6: Years
    Returns:
    
    The localized text representation of the time unit type specified in the timeUnitType parameter.
    
    Throws:
    
    VWException - Thrown if the method cannot get a localized String representation of the time unit type, for example, if the time unit type is invalid.

Methods inherited from class java.lang.Object

MINUTES

HOURS

DAYS

WEEKS

MONTHS

YEARS

VWTimeUnitType

isValid

getLocalizedString