org.apache.turbine.services.schedule
Class SchedulerTool

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

All Implemented Interfaces:

ApplicationTool

public class SchedulerTool

extends java.lang.Object

implements ApplicationTool

This tool is used to retrieve information about the job scheduler.

Version:

$Id: SchedulerTool.java 534527 2007-05-02 16:10:59Z tv $

Author:

Quinton McCombs

Constructor Summary

SchedulerTool()

Method Summary

JobEntry	getJob(java.lang.String jobId) Gets the job identified by the jobId.
java.util.List	getScheduledJobs() Gets the list of scheduled jobs.
void	init(java.lang.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(java.lang.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 java.util.List getScheduledJobs()

Gets the list of scheduled jobs.

Returns:

List of JobEntry objects.

isEnabled

public boolean isEnabled()

Determines if the scheduler service is currently enabled.

getJob

public JobEntry getJob(java.lang.String jobId)

Gets the job identified by the jobId.

Parameters:

jobId - Id of the job to retreive.

Returns:

The job. Null if the jobId is not found.