SchedulerTool (Apache Turbine 5.1-SNAPSHOT API)

java.lang.Object
- org.apache.turbine.services.schedule.SchedulerTool

All Implemented Interfaces:

ApplicationTool
```
public class SchedulerTool
extends Object
implements ApplicationTool
```
This tool is used to retrieve information about the job scheduler.

Version:

$Id$

Author:

Quinton McCombs

Constructor Summary

Constructors
Constructor Description

SchedulerTool()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JobEntry`	`getJob(String jobId)`	Gets the job identified by the jobId.
`List<? extends JobEntry>`	`getScheduledJobs()`	Gets the list of scheduled jobs.
`void`	`init(Object data)`	Initialize the pull tool
`boolean`	`isEnabled()`	Determines if the scheduler service is currently enabled.
`void`	`refresh()`	Does nothing

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SchedulerTool
```
public SchedulerTool()
```
- Method Detail
  - init
```
public void init(Object data)
```
    Initialize the pull tool
    
    Specified by:
    
    init in interface ApplicationTool
    
    Parameters:
    
    data - initialization data
  - refresh
```
public void refresh()
```
    Does nothing
    
    Specified by:
    
    refresh in interface ApplicationTool
  - getScheduledJobs
```
public List<? extends JobEntry> getScheduledJobs()
```
    Gets the list of scheduled jobs.
    
    Returns:
    
    List of JobEntry objects.
  - isEnabled
```
public boolean isEnabled()
```
    Determines if the scheduler service is currently enabled.
    
    Returns:
    
    true if the scheduler is enabled
  - getJob
```
public JobEntry getJob(String jobId)
```
    Gets the job identified by the jobId.
    
    Parameters:
    
    jobId - Id of the job to retrieve.
    
    Returns:
    
    The job. Null if the jobId is not found.