oracle.dmt.odm
Class MiningTaskState

java.lang.Object
  |
  +--oracle.dmt.odm.Enum
        |
        +--oracle.dmt.odm.MiningTaskState

All Implemented Interfaces:

java.io.Serializable

public class MiningTaskState

extends Enum

The enumeration class MiningTaskState is used to represent the states of a mining task. The semantics of the value are as follows:

• ready - ready to execute, a task will come to this state only after storing the task in the DMS
• queued - in this state task is in the queue of the DMS
• initiated - task is dequeued and initiated to execute in the DMS
• executing - task is getting excuted in the DMS
• terminating - task is in the process of terminating
• terminated - task is terminated
• success - if the task execution succeeds
• error - if the task execution fails. In this state the MiningTaskStatus object must have an error string in it.

Since:

ODM 9.2.0

See Also:

Serialized Form

Field Summary

static MiningTaskState	error If the task execution fails.
static MiningTaskState	executing Task is getting excuted in the DMS.
static MiningTaskState	initiated Task is dequeued and initiated to execute in the DMS.
static MiningTaskState	queued In this state task is in the queue of the DMS.
static MiningTaskState	ready Ready to execute, a task will come to this state only after storing the task in the DMS
static MiningTaskState	success If the task execution succeeds.
static MiningTaskState	terminated Task is terminated.
static MiningTaskState	terminating Task is in the process of terminating.

Method Summary

static MiningTaskState	getInstance(int id) Returns MiningTaskState enumeration object corresponding to the specified ID.
static MiningTaskState	getInstance(java.lang.String name) Returns MiningTaskState enumeration object corresponding to the specified name.
static MiningTaskState[]	list() Returns the list of all MiningTaskState enumerations defined.
static java.lang.String[]	listNames() Returns the list of names of all MiningTaskState enumerations defined.

Methods inherited from class oracle.dmt.odm.Enum

getEnum, getID, isEqual

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ready

public static final MiningTaskState ready

Ready to execute, a task will come to this state only after storing the task in the DMS

queued

public static final MiningTaskState queued

In this state task is in the queue of the DMS.

initiated

public static final MiningTaskState initiated

Task is dequeued and initiated to execute in the DMS.

executing

public static final MiningTaskState executing

Task is getting excuted in the DMS.

terminating

public static final MiningTaskState terminating

Task is in the process of terminating.

terminated

public static final MiningTaskState terminated

Task is terminated.

success

public static final MiningTaskState success

If the task execution succeeds.

error

public static final MiningTaskState error

If the task execution fails. In this state the MiningTaskStatus object must have an error string in it.

Method Detail

listNames

public static java.lang.String[] listNames()

Returns the list of names of all MiningTaskState enumerations defined.

Returns:

array of names for the MiningTaskState enumeration

list

public static MiningTaskState[] list()

Returns the list of all MiningTaskState enumerations defined.

Returns:

array of enumeration values for the MiningTaskState enumeration

getInstance

public static MiningTaskState getInstance(java.lang.String name)

Returns MiningTaskState enumeration object corresponding to the specified name.

Parameters:

name - of the mining task

Returns:

instance of the enumeration object corresponding to the given name, null if there is no enumeration for this name.

getInstance

public static MiningTaskState getInstance(int id)

Returns MiningTaskState enumeration object corresponding to the specified ID.

Parameters:

id - of the mining task enumeration

Returns:

instance of the MiningTaskState enumeration object corresponding to the given id, null if there is no enumeration for id.