com.inductiveautomation.ignition.gateway.tasks

Enum ScheduleMode

java.lang.Object

java.lang.Enum<ScheduleMode>

com.inductiveautomation.ignition.gateway.tasks.ScheduleMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScheduleMode>

public enum ScheduleMode
extends java.lang.Enum<ScheduleMode>

Indicates when a task should be run.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AtDelay
AtTime
Immediate
OnDemand
Scheduled

Method Summary

Modifier and Type	Method and Description
static ScheduleMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScheduleMode[]	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

Immediate

public static final ScheduleMode Immediate

AtTime

public static final ScheduleMode AtTime

AtDelay

public static final ScheduleMode AtDelay

Scheduled

public static final ScheduleMode Scheduled

OnDemand

public static final ScheduleMode OnDemand

Method Detail

values

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

Returns:

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

valueOf

public static ScheduleMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null