Package adams.scripting.command

Class AbstractRemoteCommandOnFlowWithResponse

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.command.AbstractCommand

adams.scripting.command.AbstractCommandWithResponse

adams.scripting.command.AbstractRemoteCommandOnFlowWithResponse

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, RemoteCommand, RemoteCommandOnFlow, RemoteCommandWithErrorMessage, RemoteCommandWithResponse, Serializable

Direct Known Subclasses:

GetFlow, RestartFlow, SendFlowControlCommand

public abstract class AbstractRemoteCommandOnFlowWithResponse
extends AbstractCommandWithResponse
implements RemoteCommandOnFlow

Ancestor for commands that work on flows.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	m_ID	the ID of the flow to retrieve.

Fields inherited from class adams.scripting.command.AbstractCommandWithResponse

m_ErrorMessage, m_ResponseConnection

Fields inherited from class adams.scripting.command.AbstractCommand

m_RemoteScriptingEngineHandler, m_Request

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.scripting.command.RemoteCommand

KEY_COMMAND, KEY_TYPE, VALUE_REQUEST, VALUE_RESPONSE

Constructor Summary

Constructors

Constructor	Description
AbstractRemoteCommandOnFlowWithResponse()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
int	getID()	Returns the ID of the flow to get.
abstract String	IDTipText()	Returns the tip text for this property.
protected Actor	retrieveFlow(boolean loadFromDisk)	Retrieves the flow.
void	setID(int value)	Sets the ID of the flow.

Methods inherited from class adams.scripting.command.AbstractCommandWithResponse

afterSendResponse, assembleResponse, assembleResponseHeader, beforeSendResponse, doHandleRequest, getDefaultResponseConnection, getErrorMessage, getResponseConnection, handleResponse, hasErrorMessage, parse, prepareResponsePayload, responseConnectionTipText, setResponseConnection, toString

Methods inherited from class adams.scripting.command.AbstractCommand

afterSendRequest, assembleRequest, assembleRequestHeader, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, initialize, isRequest, prepareRequestPayload, setRemoteScriptingEngineHandler, setRequest

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.scripting.command.RemoteCommand

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

Methods inherited from interface adams.scripting.command.RemoteCommandWithResponse

getResponsePayload, getResponsePayloadObjects, setResponsePayload

Field Detail

m_ID

protected Integer m_ID

the ID of the flow to retrieve.

Constructor Detail

AbstractRemoteCommandOnFlowWithResponse

public AbstractRemoteCommandOnFlowWithResponse()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractCommandWithResponse

setID

public void setID(int value)

Sets the ID of the flow.

Specified by:

setID in interface RemoteCommandOnFlow

Parameters:

value - the ID, -1 if to use the only one

getID

public int getID()

Returns the ID of the flow to get.

Specified by:

getID in interface RemoteCommandOnFlow

Returns:

the ID, -1 if to use the only one

IDTipText

public abstract String IDTipText()

Returns the tip text for this property.

Specified by:

IDTipText in interface RemoteCommandOnFlow

Returns:

tip text for this property suitable for displaying in the gui

retrieveFlow

protected Actor retrieveFlow(boolean loadFromDisk)

Retrieves the flow.
NB: Sets the error message if it fails to retrieve flow.

Parameters:

loadFromDisk - whether to load the flow from disk

Returns:

the flow, null if failed to retrieve

See Also:

AbstractCommandWithResponse.hasErrorMessage(), AbstractCommandWithResponse.getErrorMessage()