Package adams.scripting.command

Interface RemoteCommandWithErrorMessage

All Superinterfaces:

Destroyable, LoggingSupporter, OptionHandler, RemoteCommand, Serializable

All Known Subinterfaces:

RemoteCommandWithResponse

All Known Implementing Classes:

AbstractCommandWithResponse, AbstractFlowAwareCommandWithResponse, AbstractRemoteCommandOnFlowWithResponse, GetFlow, JobRunner, ListFlows, Ping, RestartFlow, RetrieveFile, RunRemoteFlow, SendFlowControlCommand, StartRemoteLogging, StopEngine, StopRemoteLogging, SystemInfo

public interface RemoteCommandWithErrorMessage
extends RemoteCommand

Interface for commands that support error message.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

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
String	getErrorMessage()	Returns the error message (if any).
boolean	hasErrorMessage()	Returns whether an error message is available.

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

hasErrorMessage

boolean hasErrorMessage()

Returns whether an error message is available.

Returns:

true if an error message available

getErrorMessage

String getErrorMessage()

Returns the error message (if any).

Returns:

the error message, null if none availabe