Content Engine Java API: DurationUnits

java.lang.Object
- com.filenet.api.constants.DurationUnits

All Implemented Interfaces:

java.io.Serializable
```
public final class DurationUnits
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants for setting the RetentionPeriodUnits property. This property specifies the time unit in which the retention duration period (DefaultRetentionPeriod property of a class definition or RetentionDurationUpdate property of a retention update policy) is expressed.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static DurationUnits`	`DAYS` Specifies a retention period in days.
`static int`	`DAYS_AS_INT` An `int` value associated with the DAYS instance of this class.
`static DurationUnits`	`HOURS` Specifies a retention period in hours.
`static int`	`HOURS_AS_INT` An `int` value associated with the HOURS instance of this class.
`static DurationUnits`	`MINUTES` Specifies a retention period in minutes.
`static int`	`MINUTES_AS_INT` An `int` value associated with the MINUTES instance of this class.
`static DurationUnits`	`MONTHS` Specifies a retention period in months.
`static int`	`MONTHS_AS_INT` An `int` value associated with the MONTHS instance of this class.
`static DurationUnits`	`SECONDS` Specifies a retention period in seconds.
`static int`	`SECONDS_AS_INT` An `int` value associated with the SECONDS instance of this class.
`static DurationUnits`	`WEEKS` Specifies a retention period in weeks.
`static int`	`WEEKS_AS_INT` An `int` value associated with the WEEKS instance of this class.
`static DurationUnits`	`YEARS` Specifies a retention period in years.
`static int`	`YEARS_AS_INT` An `int` value associated with the YEARS instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static DurationUnits`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated integer value.
`int`	`getValue()` Returns the internal integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this enumeration instance.

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

- Field Detail
  - HOURS_AS_INT
```
public static final int HOURS_AS_INT
```
    An int value associated with the HOURS instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - HOURS
```
public static final DurationUnits HOURS
```
    Specifies a retention period in hours.
  - SECONDS_AS_INT
```
public static final int SECONDS_AS_INT
```
    An int value associated with the SECONDS instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - SECONDS
```
public static final DurationUnits SECONDS
```
    Specifies a retention period in seconds.
  - YEARS_AS_INT
```
public static final int YEARS_AS_INT
```
    An int value associated with the YEARS instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - YEARS
```
public static final DurationUnits YEARS
```
    Specifies a retention period in years.
  - MONTHS_AS_INT
```
public static final int MONTHS_AS_INT
```
    An int value associated with the MONTHS instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - MONTHS
```
public static final DurationUnits MONTHS
```
    Specifies a retention period in months.
  - DAYS_AS_INT
```
public static final int DAYS_AS_INT
```
    An int value associated with the DAYS instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - DAYS
```
public static final DurationUnits DAYS
```
    Specifies a retention period in days.
  - MINUTES_AS_INT
```
public static final int MINUTES_AS_INT
```
    An int value associated with the MINUTES instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - MINUTES
```
public static final DurationUnits MINUTES
```
    Specifies a retention period in minutes.
  - WEEKS_AS_INT
```
public static final int WEEKS_AS_INT
```
    An int value associated with the WEEKS instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - WEEKS
```
public static final DurationUnits WEEKS
```
    Specifies a retention period in weeks.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns the internal integer value associated with a specific instance of this class.
    
    Returns:
    The enumeration instance's ordinal value.
    See Also:
    getInstanceFromInt(int)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The enumeration instance's description.
  - getInstanceFromInt
```
public static DurationUnits getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value.
    
    Parameters:
    value - The integer value. (See the *_AS_INT fields.)
    
    Returns:
    The enumeration instance with the given ordinal value.
    
    Throws:
    
    EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
    See Also:
    getValue()

Methods inherited from class java.lang.Object

HOURS_AS_INT

HOURS

SECONDS_AS_INT

SECONDS

YEARS_AS_INT

YEARS

MONTHS_AS_INT

MONTHS

DAYS_AS_INT

DAYS

MINUTES_AS_INT

MINUTES

WEEKS_AS_INT

WEEKS

getValue

toString

getInstanceFromInt