com.ace.moab.api.jobs
Enum JobHoldType

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

All Implemented Interfaces:

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

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

This enumeration represents the types of holds that can be applied to jobs.

Author:

Brady Kimball

Enum Constant Summary

ALL
The job has all holds applied to it.

BATCH
The batch queue has placed a hold on the job.

DEFER
The job has been deferred.

NONE
The job does not have a hold.

SYSTEM
Moab has put a hold on the job.

USER
The user has manually specified a hold on a job.

Method Summary

static JobHoldType	parseString(java.lang.String string) Attempts to parse a string and convert it into a corresponding JobHoldType enum value.
static JobHoldType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobHoldType[]	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

NONE

public static final JobHoldType NONE

The job does not have a hold.

USER

public static final JobHoldType USER

The user has manually specified a hold on a job.

SYSTEM

public static final JobHoldType SYSTEM

Moab has put a hold on the job.

BATCH

public static final JobHoldType BATCH

The batch queue has placed a hold on the job.

DEFER

public static final JobHoldType DEFER

The job has been deferred.

ALL

public static final JobHoldType ALL

The job has all holds applied to it.

Method Detail

values

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

Returns:

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

valueOf

public static JobHoldType 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 JobHoldType parseString(java.lang.String string)
                               throws java.text.ParseException

Attempts to parse a string and convert it into a corresponding JobHoldType enum value.

Parameters:

string - the string to parse into a corresponding JobHoldType enum value.

Returns:

the corresponding JobHoldType enum value.

Throws:

java.text.ParseException - thrown if the string cannot be parsed into a respective JobHoldType.