Process Class Relationships

filenet.vw.api
Class VWTimeUnitType

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
static int DAYS
          Integer value of 3. Specify days as the time unit.
static int HOURS
          Integer value of 2. Specify hours as the time unit.
static int MINUTES
          Integer value of 1. Specify minutes the time unit.
static int MONTHS
          Integer value of 5. Specify months as the time unit.
static int WEEKS
          Integer value of 4. Specify weeks as the time unit.
static int YEARS
          Integer value of 6. Specify years as the time unit.
 
Constructor Summary
VWTimeUnitType()
           
 
Method Summary
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
Integer value of 1. Specify minutes the time unit.

HOURS

public static final int HOURS
Integer value of 2. Specify hours as the time unit.

DAYS

public static final int DAYS
Integer value of 3. Specify days as the time unit.

WEEKS

public static final int WEEKS
Integer value of 4. Specify weeks as the time unit.

MONTHS

public static final int MONTHS
Integer value of 5. Specify months as the time unit.

YEARS

public static final int YEARS
Integer value of 6. Specify years as the time unit.
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:
A Boolean value. The method returns true if the value specified in the timeUnitType parameter is valid; otherwise, the method 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 it cannot get a localized String representation of the time unit type, for example, if the time unit type is invalid.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.