Package de.xima.fc.mdl.enums

Enum ETimePointTriggerDurationUnit

java.lang.Object

java.lang.Enum<ETimePointTriggerDurationUnit>

de.xima.fc.mdl.enums.ETimePointTriggerDurationUnit

All Implemented Interfaces:

INamedUiElement, Serializable, Comparable<ETimePointTriggerDurationUnit>

public enum ETimePointTriggerDurationUnit
extends Enum<ETimePointTriggerDurationUnit>
implements INamedUiElement

Enumeration of the available duration units the user can enter for EWorkflowTriggerType.FC_TIME_POINT.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAYS	One hour (24 HOURS).
HOURS	One hour (60 MINUTES).
MINUTES	One minute (60 SECONDS).
MONTHS	One month (variable amount of time, depending on the date).
SECONDS	One second.
WEEKS	One week (variable amount of time, depending on the date).
YEARS	One year (variable amount of time, depending on the date).

Field Summary

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method	Description
String	getDisplayName(Locale locale)	The display name of this element in the given locale.
abstract ZonedDateTime	plus(ZonedDateTime dateTime, long amount)	Adds the given amount of this unit to the given date time.
static ETimePointTriggerDurationUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ETimePointTriggerDurationUnit[]	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

DAYS

public static final ETimePointTriggerDurationUnit DAYS

One hour (24 HOURS).

HOURS

public static final ETimePointTriggerDurationUnit HOURS

One hour (60 MINUTES).

MINUTES

public static final ETimePointTriggerDurationUnit MINUTES

One minute (60 SECONDS).

MONTHS

public static final ETimePointTriggerDurationUnit MONTHS

One month (variable amount of time, depending on the date).

SECONDS

public static final ETimePointTriggerDurationUnit SECONDS

One second.

WEEKS

public static final ETimePointTriggerDurationUnit WEEKS

One week (variable amount of time, depending on the date).

YEARS

public static final ETimePointTriggerDurationUnit YEARS

One year (variable amount of time, depending on the date).

Method Detail

values

public static ETimePointTriggerDurationUnit[] 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 (ETimePointTriggerDurationUnit c : ETimePointTriggerDurationUnit.values())
    System.out.println(c);

Returns:

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

valueOf

public static ETimePointTriggerDurationUnit 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

getDisplayName

public String getDisplayName(Locale locale)

Description copied from interface: INamedUiElement

The display name of this element in the given locale.

Specified by:

getDisplayName in interface INamedUiElement

Parameters:

locale - The locale to get the display name for.

Returns:

The display name of this element in the given locale.

plus

public abstract ZonedDateTime plus(ZonedDateTime dateTime,
                                   long amount)

Adds the given amount of this unit to the given date time.

Parameters:

dateTime - Date time to which to add.

amount - Amount to add.

Returns:

The date time plus the given amount of this unit.