Package gda.commandqueue

Interface Command

All Superinterfaces:

gda.observable.IObservable, Serializable

All Known Implementing Classes:

BatonPassCommand, CommandBase, ExperimentCommand, JythonCommandStringRunnerCommand, JythonScriptFileRunnerCommand, StopCommand

public interface Command
extends gda.observable.IObservable, Serializable

The Command interface for commands to be stored in CommandQueue and processed by FindableProcessorQueue A Command can be run, paused, aborted and has a state. Observers receive CommandProgress objects

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Command.STATE

Method Summary

Modifier and Type	Method	Description
void	abort()
CommandSummary	getCommandSummary()
String	getDescription()
CommandDetails	getDetails()
Command.STATE	getState()
void	pause()
void	resume()
void	run()
void	setDetails(String details)

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Method Details

getDescription

String getDescription()
               throws Exception

Throws:

Exception

getDetails

CommandDetails getDetails()
                   throws Exception

Throws:

Exception

setDetails

void setDetails(String details)
         throws Exception

Throws:

Exception

run

void run()
  throws Exception

Throws:

Exception

pause

void pause()
    throws Exception

Throws:

Exception

abort

void abort()
    throws Exception

Throws:

Exception

resume

void resume()
     throws Exception

Throws:

Exception

getState

Command.STATE getState()
                throws Exception

Throws:

Exception

getCommandSummary

CommandSummary getCommandSummary()
                          throws Exception

Throws:

Exception