com.ace.moab.api.triggers
Enum TriggerActionType

java.lang.Object
  java.lang.Enum<TriggerActionType>
      com.ace.moab.api.triggers.TriggerActionType

All Implemented Interfaces:

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

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

This enums describes what kind of action a trigger can take when it fires. The values inside this enumeration are associated with the trigger attribute AType.

Enum Constant Summary

CANCEL
The attempts to cancel the object it is attached to.

EXEC
The trigger attempts to execute an external program.

INTERNAL
The trigger can be used to modify object internals using the following format for the action:

JOBPREEMPT
The trigger should preempt all jobs currently allocating resource assigned to the trigger's parent object.

MAIL
The trigger attempts to email the administrator.

QUERY
The trigger is allowed to import variables from another object.

Method Summary

static TriggerActionType	parseString(java.lang.String string) Parses a string and converts it into a TriggerActionType enum value if possible.
static TriggerActionType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TriggerActionType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CANCEL

public static final TriggerActionType CANCEL

The attempts to cancel the object it is attached to. This action type only applies to triggers attached to reservations.

EXEC

public static final TriggerActionType EXEC

The trigger attempts to execute an external program.

INTERNAL

public static final TriggerActionType INTERNAL

The trigger can be used to modify object internals using the following format for the action:

<OBJECT_TYPE>:<OBJECT_ID>:<ACTION>:<CONTEXT_DATA>

Several different actions are valid depending on what type of object the internal trigger is acting upon.

JOBPREEMPT

public static final TriggerActionType JOBPREEMPT

The trigger should preempt all jobs currently allocating resource assigned to the trigger's parent object. This only applies to triggers attached to reservations.

MAIL

public static final TriggerActionType MAIL

The trigger attempts to email the administrator.

QUERY

public static final TriggerActionType QUERY

The trigger is allowed to import variables from another object.

Method Detail

values

public static final TriggerActionType[] values()

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

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

Returns:

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

valueOf

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

parseString

public static TriggerActionType parseString(java.lang.String string)
                                     throws java.lang.IllegalArgumentException

Parses a string and converts it into a TriggerActionType enum value if possible.

Parameters:

string - the string to be parsed.

Returns:

the corresponding TriggerActionType enum value.

Throws:

java.lang.IllegalArgumentException - if the String cannot be parsed.