com.ace.moab.api.jobs
Enum JobEmailNotifyType

java.lang.Object
  java.lang.Enum<JobEmailNotifyType>
      com.ace.moab.api.jobs.JobEmailNotifyType

All Implemented Interfaces:

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

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

This enumeration represents the types of e-mail notifications that can happen in relation to a job's status. In order to use this functionality, a valid e-mail server must be setup.

Author:

Brady Kimball

Enum Constant Summary

JOB_END
An e-mail will be sent out when the job successfully ends.

JOB_FAIL
An e-mail will be sent out when the job fails.

JOB_START
An e-mail will be sent out when the job starts.

Method Summary

static JobEmailNotifyType	parseString(java.lang.String string) Parse a string and converts it into a corresponding JobEmailNotifyType enum value.
java.lang.String	toMoabString() Returns the enumerated value in a format that Moab recognizes
java.lang.String	toString()
static JobEmailNotifyType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobEmailNotifyType[]	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, valueOf

Methods inherited from class java.lang.Object

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

Enum Constant Detail

JOB_END

public static final JobEmailNotifyType JOB_END

An e-mail will be sent out when the job successfully ends.

JOB_FAIL

public static final JobEmailNotifyType JOB_FAIL

An e-mail will be sent out when the job fails.

JOB_START

public static final JobEmailNotifyType JOB_START

An e-mail will be sent out when the job starts.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<JobEmailNotifyType>

toMoabString

public java.lang.String toMoabString()

Returns the enumerated value in a format that Moab recognizes

Returns:

the enumerated value in a format that Moab recognizes

parseString

public static JobEmailNotifyType parseString(java.lang.String string)
                                      throws java.text.ParseException

Parse a string and converts it into a corresponding JobEmailNotifyType enum value.

Parameters:

string - the string to parse.

Returns:

a corresponding JobEmailNotifyType enum value.

Throws:

java.text.ParseException - thrown if the String does not match any JobEmailNotifyType value.