org.globus.cog.gridshell.interfaces
Interface Command

All Superinterfaces:

Comparable, PropertyChangeNotifier, Runnable

All Known Subinterfaces:

GridShell, Program

All Known Implementing Classes:

AbstractCommand, AbstractProgram, Gsh

public interface Command

extends Runnable, PropertyChangeNotifier, Comparable

Method Summary

Object	destroy() Destroys this command - called after the command has been completed
Object	execute() Executes this command
Identity	getIdentity() Returns an identity for this command
Command	getParent() Returns the parent of this command
Object	getResult() Returns a result for this command once the status is COMPLETED
Scope	getScope() Returns the scope associated with this command
Status	getStatus() The status of this command
Object	init(Map args) Used to init this command
Object	kill() Kills this command
Object	resume() Resumes this command
void	setStatusCode(int statusCode) Sets the status of this Command
Object	suspend() Suspends this command

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface org.globus.cog.gridshell.interfaces.PropertyChangeNotifier

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

init

public Object init(Map args)
            throws Exception

Used to init this command

Parameters:

args - - a mapping of variable name to variable value

Returns:

Throws:

Exception

execute

public Object execute()
               throws Exception

Executes this command

Returns:

Throws:

Exception

suspend

public Object suspend()
               throws Exception

Suspends this command

Returns:

Throws:

Exception

resume

public Object resume()
              throws Exception

Resumes this command

Returns:

Throws:

Exception

kill

public Object kill()
            throws Exception

Kills this command

Returns:

Throws:

Exception

destroy

public Object destroy()
               throws Exception

Destroys this command - called after the command has been completed

Returns:

Throws:

Exception

getResult

public Object getResult()

Returns a result for this command once the status is COMPLETED

Returns:

getScope

public Scope getScope()

Returns the scope associated with this command

Returns:

getIdentity

public Identity getIdentity()

Returns an identity for this command

Returns:

getParent

public Command getParent()

Returns the parent of this command

Returns:

getStatus

public Status getStatus()

The status of this command

Returns:

setStatusCode

public void setStatusCode(int statusCode)

Sets the status of this Command

Parameters:

statusCode -