org.trianacode.taskgraph.service

Interface SchedulerInterface

All Known Implementing Classes:

Scheduler

public interface SchedulerInterface

The Interface that all schedulers must implement. This allows us to easily "bolt" in new scheduler algorithms should we wish.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExecutionListener(ExecutionListener listener)
void	flushTaskGraph() Flushes all data from the task graph cables
ExecutionState	getExecutionState()
void	notifyError(RunnableInstance cause, java.lang.String message) Called to notify an error has occured in the taskgraph
void	pauseTaskGraph() Gracefully halt the execution of the task graph, retaining state information.
void	removeExecutionListener(ExecutionListener listener)
void	resetTaskGraph() Halt the taskgraph and reset all units to their start values.
void	resumeTaskGraph() Continue after a pause.
void	runTask(Task task) Runs the specified task within a running taskgraph
void	runTaskGraph() Runs the taskgraph by waking up all the input tasks.
void	runTaskGraph(HistoryClipIn history) Runs the taskgraph by waking up all the input tasks.
void	setExecutionProperties(java.util.HashMap<java.lang.String,java.lang.String> executionProperties)

Method Detail

getExecutionState

ExecutionState getExecutionState()

Returns:

the taskgraph state

runTaskGraph

void runTaskGraph()
                  throws SchedulerException

Runs the taskgraph by waking up all the input tasks.

Throws:

SchedulerException

runTaskGraph

void runTaskGraph(HistoryClipIn history)
                  throws SchedulerException

Runs the taskgraph by waking up all the input tasks. Attaches the specified object as a history clip-in

Throws:

SchedulerException

runTask

void runTask(Task task)
             throws SchedulerException

Runs the specified task within a running taskgraph

Throws:

SchedulerException

pauseTaskGraph

void pauseTaskGraph()
                    throws SchedulerException

Gracefully halt the execution of the task graph, retaining state information.

Throws:

SchedulerException

resumeTaskGraph

void resumeTaskGraph()
                     throws SchedulerException

Continue after a pause.

Throws:

SchedulerException

resetTaskGraph

void resetTaskGraph()
                    throws SchedulerException

Halt the taskgraph and reset all units to their start values.

Throws:

SchedulerException

flushTaskGraph

void flushTaskGraph()
                    throws SchedulerException

Flushes all data from the task graph cables

Throws:

SchedulerException

notifyError

void notifyError(RunnableInstance cause,
               java.lang.String message)

Called to notify an error has occured in the taskgraph

Parameters:

cause - the cause of the error

addExecutionListener

void addExecutionListener(ExecutionListener listener)

removeExecutionListener

void removeExecutionListener(ExecutionListener listener)

setExecutionProperties

void setExecutionProperties(java.util.HashMap<java.lang.String,java.lang.String> executionProperties)