SchedulerStatus (scheduling 14.1.0-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, Comparable<SchedulerStatus>
```
@PublicAPI
public enum SchedulerStatus
extends Enum<SchedulerStatus>
implements Serializable
```
Status of the scheduler. The status and what you can do with the scheduler according to the current status are best described below.

Since:

ProActive Scheduling 0.9

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DB_DOWN` The scheduler has been killed due to a db disconnection, nothing can be done anymore.
`FROZEN` The scheduler is in freeze mode.
`KILLED` The scheduler has been killed, nothing can be done anymore.
`PAUSED` The scheduler is paused.
`SHUTTING_DOWN` The scheduler is shutting down, It will terminate all running jobs (during this time, get jobs results is possible), then it will serialize every remaining jobs results that still are in the finished queue.
`STARTED` The scheduler is running.
`STOPPED` The scheduler is stopped.
`UNLINKED` The scheduler is unlinked with RM, This can be due to the crash of the resource manager.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isDown()` Return true if the scheduler is not currently UP
`boolean`	`isFreezable()` Return true if the scheduler is freezable in its current state
`boolean`	`isKilled()` Return true if the scheduler is killed
`boolean`	`isPausable()` Return true if the scheduler is pausable in its current state
`boolean`	`isResumable()` Return true if the scheduler is resumable in its current state
`boolean`	`isShuttingDown()` Return true if the scheduler is currently shutting down
`boolean`	`isStartable()` Return true if the scheduler is startable
`boolean`	`isStoppable()` Return true if the scheduler can be stopped in its current state.
`boolean`	`isSubmittable()` Return true if a job can be submitted to scheduler
`boolean`	`isUnusable()` Return true if the scheduler is NOT usable in its current state
`String`	`toString()`
`static SchedulerStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SchedulerStatus[]`	`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
  - STARTED
```
public static final SchedulerStatus STARTED
```
    The scheduler is running. Jobs can be submitted. Get the jobs results is possible. It can be paused, stopped or shutdown.
  - STOPPED
```
public static final SchedulerStatus STOPPED
```
    The scheduler is stopped. Jobs cannot be submitted anymore. It will terminate every submitted jobs. Get the jobs results is possible. It can be started or shutdown.
  - FROZEN
```
public static final SchedulerStatus FROZEN
```
    The scheduler is in freeze mode. It means that every running tasks will be terminated, but the pending jobs will wait for the scheduler to resume. It can be resumed, stopped, paused or shutdown.
  - PAUSED
```
public static final SchedulerStatus PAUSED
```
    The scheduler is paused. It means that every running jobs will be terminated. It can be resumed, stopped, frozen or shutdown.
  - SHUTTING_DOWN
```
public static final SchedulerStatus SHUTTING_DOWN
```
    The scheduler is shutting down, It will terminate all running jobs (during this time, get jobs results is possible), then it will serialize every remaining jobs results that still are in the finished queue. Finally, it will shutdown the scheduler.
  - UNLINKED
```
public static final SchedulerStatus UNLINKED
```
    The scheduler is unlinked with RM, This can be due to the crash of the resource manager. This status will block every called to the scheduler except the terminate one and the call to reconnect to a new Resource Manager.
  - KILLED
```
public static final SchedulerStatus KILLED
```
    The scheduler has been killed, nothing can be done anymore. (Similar to Ctrl-C)
  - DB_DOWN
```
public static final SchedulerStatus DB_DOWN
```
    The scheduler has been killed due to a db disconnection, nothing can be done anymore.
- Method Detail
  - values
```
public static SchedulerStatus[] 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 (SchedulerStatus c : SchedulerStatus.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SchedulerStatus 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<SchedulerStatus>
    
    See Also:
    
    Enum.toString()
  - isKilled
```
public boolean isKilled()
```
    Return true if the scheduler is killed
    
    Returns:
    
    true if the scheduler is killed
  - isShuttingDown
```
public boolean isShuttingDown()
```
    Return true if the scheduler is currently shutting down
    
    Returns:
    
    true if the scheduler is currently shutting down
  - isUnusable
```
public boolean isUnusable()
```
    Return true if the scheduler is NOT usable in its current state
    
    Returns:
    
    true if the scheduler is NOT usable in its current state
  - isDown
```
public boolean isDown()
```
    Return true if the scheduler is not currently UP
    
    Returns:
    
    true if the scheduler is not currently UP
  - isStoppable
```
public boolean isStoppable()
```
    Return true if the scheduler can be stopped in its current state.
    
    Returns:
    
    true if the scheduler can be stopped in its current state.
  - isStartable
```
public boolean isStartable()
```
    Return true if the scheduler is startable
    
    Returns:
    
    true if the scheduler is startable
  - isFreezable
```
public boolean isFreezable()
```
    Return true if the scheduler is freezable in its current state
    
    Returns:
    
    true if the scheduler is freezable in its current state
  - isPausable
```
public boolean isPausable()
```
    Return true if the scheduler is pausable in its current state
    
    Returns:
    
    true if the scheduler is pausable in its current state
  - isResumable
```
public boolean isResumable()
```
    Return true if the scheduler is resumable in its current state
    
    Returns:
    
    true if the scheduler is resumable in its current state
  - isSubmittable
```
public boolean isSubmittable()
```
    Return true if a job can be submitted to scheduler
    
    Returns:
    
    true if a job can be submitted to scheduler

Enum SchedulerStatus

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STARTED

STOPPED

FROZEN

PAUSED

SHUTTING_DOWN

UNLINKED

KILLED

DB_DOWN

Method Detail

values

valueOf

toString

isKilled

isShuttingDown

isUnusable

isDown

isStoppable

isStartable

isFreezable

isPausable

isResumable

isSubmittable