Package adams.scripting.command

Interface RemoteCommandOnFlow

All Superinterfaces:

Destroyable, LoggingSupporter, OptionHandler, RemoteCommand, Serializable

All Known Implementing Classes:

AbstractRemoteCommandOnFlowWithResponse, GetFlow, RestartFlow, SendFlowControlCommand

public interface RemoteCommandOnFlow
extends RemoteCommand

Interface for remote commands that operate on a specific flow, identified by its ID.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

RunningFlowsRegistry, RegisterFlow

Field Summary

Fields inherited from interface adams.scripting.command.RemoteCommand

KEY_COMMAND, KEY_TYPE, VALUE_REQUEST, VALUE_RESPONSE

Method Summary

Modifier and Type	Method	Description
int	getID()	Returns the ID of the flow to get.
String	IDTipText()	Returns the tip text for this property.
void	setID(int value)	Sets the ID of the flow.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.scripting.command.RemoteCommand

afterSendRequest, assembleRequest, beforeSendRequest, getRemoteScriptingEngineHandler, getRequestPayload, getRequestPayloadObjects, handleRequest, isRequest, parse, setRemoteScriptingEngineHandler, setRequest, setRequestPayload

Method Detail

setID

void setID(int value)

Sets the ID of the flow.

Parameters:

value - the ID (shortcut: -1 if there is only one)

getID

int getID()

Returns the ID of the flow to get.

Returns:

the ID (shortcut: -1 if there is only one)

IDTipText

String IDTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui