Package step.repository.alm.otaclient

Enum TDAPI_PURGE_RUNS

java.lang.Object

java.lang.Enum<TDAPI_PURGE_RUNS>

step.repository.alm.otaclient.TDAPI_PURGE_RUNS

All Implemented Interfaces:

com4j.ComEnum, Serializable, Comparable<TDAPI_PURGE_RUNS>

public enum TDAPI_PURGE_RUNS
extends Enum<TDAPI_PURGE_RUNS>
implements com4j.ComEnum

The units by which to purge.

Enum Constant Summary

Enum Constants

Enum Constant	Description
TDDATE_PURGE	Purge by date.
TDDAY_PURGE	Purge by number of days.
TDMONTH_PURGE	Purge by number of months.
TDWEEK_PURGE	Purge by number of weeks.
TDYEAR_PURGE	Purge by number of years.

Method Summary

Modifier and Type	Method	Description
int	comEnumValue()
static TDAPI_PURGE_RUNS	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TDAPI_PURGE_RUNS[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TDDAY_PURGE

public static final TDAPI_PURGE_RUNS TDDAY_PURGE

Purge by number of days.

The value of this constant is 1

TDWEEK_PURGE

public static final TDAPI_PURGE_RUNS TDWEEK_PURGE

Purge by number of weeks.

The value of this constant is 2

TDMONTH_PURGE

public static final TDAPI_PURGE_RUNS TDMONTH_PURGE

Purge by number of months.

The value of this constant is 3

TDYEAR_PURGE

public static final TDAPI_PURGE_RUNS TDYEAR_PURGE

Purge by number of years.

The value of this constant is 4

TDDATE_PURGE

public static final TDAPI_PURGE_RUNS TDDATE_PURGE

Purge by date.

The value of this constant is 5

Method Detail

values

public static TDAPI_PURGE_RUNS[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TDAPI_PURGE_RUNS c : TDAPI_PURGE_RUNS.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TDAPI_PURGE_RUNS valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

comEnumValue

public int comEnumValue()

Specified by:

comEnumValue in interface com4j.ComEnum