SchedulerEvent (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<SchedulerEvent>
- - org.ow2.proactive.scheduler.common.SchedulerEvent

All Implemented Interfaces:

Serializable, Comparable<SchedulerEvent>
```
@PublicAPI
public enum SchedulerEvent
extends Enum<SchedulerEvent>
```
Enumeration of all different events that scheduler can invoke.
This is also used to choose which events you want to received from the scheduler.

Since:

ProActive Scheduling 0.9

See Also:

for more details. $Id$

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DB_DOWN` The database is no more available.
`FROZEN` The scheduler has just been frozen, this pause will stop every process except the running one.
`JOB_ABORTED` A job has been aborted due to a node failure, manuel kill by the user, or error policy This event is only used in the JobEmailNotification to filter aborted jobs from finished jobs
`JOB_CHANGE_PRIORITY` The priority of a job has just been change.
`JOB_IN_ERROR` A job has just been paused on error.
`JOB_PAUSED` A job has just been paused.
`JOB_PENDING_TO_FINISHED` A job has been terminated from pending queue.
`JOB_PENDING_TO_RUNNING` A job has just been scheduled.
`JOB_REMOVE_FINISHED` A job has just been removed from scheduler.
`JOB_RESTARTED_FROM_ERROR` A job has just been restarted from error.
`JOB_RESUMED` A job has just been resumed.
`JOB_RUNNING_TO_FINISHED` A job has just finished.
`JOB_RUNNING_TO_FINISHED_WITH_ERRORS` A job has been terminated with at least one faulty task This event is only used in the JobEmailNotification to filter finishied jobs with errors from all finished jobs
`JOB_SUBMITTED` A job has just been submitted.
`JOB_UPDATED` A job has just been updated.
`KILLED` The scheduler has just been killed.
`PAUSED` The scheduler has just been paused.
`POLICY_CHANGED` The scheduling policy has been changed.
`RESUMED` The scheduler has just been resumed.
`RM_DOWN` The Resource Manager is no more available.
`RM_UP` The Resource Manager is re-available .
`SHUTDOWN` Deprecated.
`SHUTTING_DOWN` The scheduler is shutting down.
`STARTED` The scheduler has just been started.
`STOPPED` The scheduler has just been stopped.
`TASK_IN_ERROR` A task has just been paused due to an error while executing
`TASK_IN_ERROR_TO_FINISHED` A task has just had an error, was marked as finished.
`TASK_PENDING_TO_RUNNING` A task has just been scheduled.
`TASK_PROGRESS` A new task progress value is available
`TASK_REPLICATED` A Control Flow Action led to the replication of a task
`TASK_RUNNING_TO_FINISHED` A task has just finished.
`TASK_SKIPPED` A Control Flow Action (branching) led to a task being skipped
`TASK_VARIABLES_UPDATED` A task variables have been updated
`TASK_VISU_ACTIVATED` when the visualization is activated on a task
`TASK_WAITING_FOR_RESTART` A task has just had an error, it will wait for restart.
`USERS_UPDATE` A user has just connect the scheduler or submit a job.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`toString()`
`static SchedulerEvent`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SchedulerEvent[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - FROZEN
```
public static final SchedulerEvent FROZEN
```
    The scheduler has just been frozen, this pause will stop every process except the running one.
  - RESUMED
```
public static final SchedulerEvent RESUMED
```
    The scheduler has just been resumed.
  - SHUTDOWN
```
@Deprecated
public static final SchedulerEvent SHUTDOWN
```
    Deprecated.
    
    The scheduler has just been shutdown.
  - SHUTTING_DOWN
```
public static final SchedulerEvent SHUTTING_DOWN
```
    The scheduler is shutting down.
  - STARTED
```
public static final SchedulerEvent STARTED
```
    The scheduler has just been started.
  - STOPPED
```
public static final SchedulerEvent STOPPED
```
    The scheduler has just been stopped. Every jobs will be stopped and running tasks will finished.
  - KILLED
```
public static final SchedulerEvent KILLED
```
    The scheduler has just been killed.
  - JOB_PAUSED
```
public static final SchedulerEvent JOB_PAUSED
```
    A job has just been paused. It will finished the running task.
  - JOB_PENDING_TO_RUNNING
```
public static final SchedulerEvent JOB_PENDING_TO_RUNNING
```
    A job has just been scheduled. At least one of its task is running.
  - JOB_RESUMED
```
public static final SchedulerEvent JOB_RESUMED
```
    A job has just been resumed.
  - JOB_SUBMITTED
```
public static final SchedulerEvent JOB_SUBMITTED
```
    A job has just been submitted.
  - JOB_RUNNING_TO_FINISHED
```
public static final SchedulerEvent JOB_RUNNING_TO_FINISHED
```
    A job has just finished. All tasks are finished.
  - JOB_REMOVE_FINISHED
```
public static final SchedulerEvent JOB_REMOVE_FINISHED
```
    A job has just been removed from scheduler.
  - TASK_PENDING_TO_RUNNING
```
public static final SchedulerEvent TASK_PENDING_TO_RUNNING
```
    A task has just been scheduled. It is now running.
  - TASK_RUNNING_TO_FINISHED
```
public static final SchedulerEvent TASK_RUNNING_TO_FINISHED
```
    A task has just finished.
  - TASK_WAITING_FOR_RESTART
```
public static final SchedulerEvent TASK_WAITING_FOR_RESTART
```
    A task has just had an error, it will wait for restart.
  - JOB_CHANGE_PRIORITY
```
public static final SchedulerEvent JOB_CHANGE_PRIORITY
```
    The priority of a job has just been change.
  - PAUSED
```
public static final SchedulerEvent PAUSED
```
    The scheduler has just been paused. Every running job will be finished.
  - RM_DOWN
```
public static final SchedulerEvent RM_DOWN
```
    The Resource Manager is no more available.
  - RM_UP
```
public static final SchedulerEvent RM_UP
```
    The Resource Manager is re-available .
  - USERS_UPDATE
```
public static final SchedulerEvent USERS_UPDATE
```
    A user has just connect the scheduler or submit a job.
  - POLICY_CHANGED
```
public static final SchedulerEvent POLICY_CHANGED
```
    The scheduling policy has been changed.
  - JOB_PENDING_TO_FINISHED
```
public static final SchedulerEvent JOB_PENDING_TO_FINISHED
```
    A job has been terminated from pending queue. All tasks are finished.
  - TASK_REPLICATED
```
public static final SchedulerEvent TASK_REPLICATED
```
    A Control Flow Action led to the replication of a task
  - TASK_SKIPPED
```
public static final SchedulerEvent TASK_SKIPPED
```
    A Control Flow Action (branching) led to a task being skipped
  - TASK_PROGRESS
```
public static final SchedulerEvent TASK_PROGRESS
```
    A new task progress value is available
  - DB_DOWN
```
public static final SchedulerEvent DB_DOWN
```
    The database is no more available.
  - JOB_IN_ERROR
```
public static final SchedulerEvent JOB_IN_ERROR
```
    A job has just been paused on error. It means that job execution can no longer progress due to one or more tasks which are in paused on error state.
  - TASK_IN_ERROR
```
public static final SchedulerEvent TASK_IN_ERROR
```
    A task has just been paused due to an error while executing
  - JOB_RESTARTED_FROM_ERROR
```
public static final SchedulerEvent JOB_RESTARTED_FROM_ERROR
```
    A job has just been restarted from error.
  - JOB_UPDATED
```
public static final SchedulerEvent JOB_UPDATED
```
    A job has just been updated.
  - TASK_IN_ERROR_TO_FINISHED
```
public static final SchedulerEvent TASK_IN_ERROR_TO_FINISHED
```
    A task has just had an error, was marked as finished.
  - JOB_RUNNING_TO_FINISHED_WITH_ERRORS
```
public static final SchedulerEvent JOB_RUNNING_TO_FINISHED_WITH_ERRORS
```
    A job has been terminated with at least one faulty task This event is only used in the JobEmailNotification to filter finishied jobs with errors from all finished jobs
  - JOB_ABORTED
```
public static final SchedulerEvent JOB_ABORTED
```
    A job has been aborted due to a node failure, manuel kill by the user, or error policy This event is only used in the JobEmailNotification to filter aborted jobs from finished jobs
  - TASK_VISU_ACTIVATED
```
public static final SchedulerEvent TASK_VISU_ACTIVATED
```
    when the visualization is activated on a task
  - TASK_VARIABLES_UPDATED
```
public static final SchedulerEvent TASK_VARIABLES_UPDATED
```
    A task variables have been updated
- Method Detail
  - values
```
public static SchedulerEvent[] 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 (SchedulerEvent c : SchedulerEvent.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SchedulerEvent valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<SchedulerEvent>
    
    See Also:
    
    Override the toString() method, to make sure each time it returns the value (eg: "Job paused") not the key (eg: JOB_PAUSED)

Enum SchedulerEvent

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FROZEN

RESUMED

SHUTDOWN

SHUTTING_DOWN

STARTED

STOPPED

KILLED

JOB_PAUSED

JOB_PENDING_TO_RUNNING

JOB_RESUMED

JOB_SUBMITTED

JOB_RUNNING_TO_FINISHED

JOB_REMOVE_FINISHED

TASK_PENDING_TO_RUNNING

TASK_RUNNING_TO_FINISHED

TASK_WAITING_FOR_RESTART

JOB_CHANGE_PRIORITY

PAUSED

RM_DOWN

RM_UP

USERS_UPDATE

POLICY_CHANGED

JOB_PENDING_TO_FINISHED

TASK_REPLICATED

TASK_SKIPPED

TASK_PROGRESS

DB_DOWN

JOB_IN_ERROR

TASK_IN_ERROR

JOB_RESTARTED_FROM_ERROR

JOB_UPDATED

TASK_IN_ERROR_TO_FINISHED

JOB_RUNNING_TO_FINISHED_WITH_ERRORS

JOB_ABORTED

TASK_VISU_ACTIVATED

TASK_VARIABLES_UPDATED

Method Detail

values

valueOf

toString