| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.core.actions.ActionData |
 Known Direct Subclasses
|
Class Overview
Base action data class. This class is meant to be subclassed.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | ERRCODE_UNKNOWN | The error code 0 means that no error code was set-up. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ActionData() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
canReuseObject()
Determine whether this action data object may be safely reused after a
reset()
invocation. | ||||||||||
| String |
getDescription()
Retrieve the description string provided by the plugins.
| ||||||||||
| int |
getExecutionErrorCode()
The client may retrieve the optionally-set execution error code after a failed call to
executeAction() | ||||||||||
| String |
getExecutionErrorMessage()
The client may retrieve the optionally-set execution error message after a failed call to
executeAction() | ||||||||||
| Object |
getValue(String key)
Convenience method used to store any object.
| ||||||||||
| void |
reset()
Reset this action data object.
| ||||||||||
| void |
setDescription(String description)
Set the description string to be provided to the clients.
| ||||||||||
| void |
setExecutionError(int code, String msg)
The plugin may set an execution error code and message on a failed
executeAction()
invocation. | ||||||||||
| void |
setExecutionErrorCode(int code)
The plugin may set an execution error code on a failed
executeAction()
invocation. | ||||||||||
| void |
setExecutionErrorMessage(String msg)
The plugin may set an execution error message on a failed
executeAction()
invocation. | ||||||||||
| void |
setValue(String key, Object value)
Convenience method used to retrieve previously stored objects.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.actions.IActionData
| |||||||||||
Constants
public static final int ERRCODE_UNKNOWN
The error code 0 means that no error code was set-up. Meaningful error codes must be non-zero, and are defined within specific action data classes (sub-classes of this class).
Public Constructors
public ActionData ()
Public Methods
public boolean canReuseObject ()
Determine whether this action data object may be safely reused after a reset()
invocation.
public String getDescription ()
Retrieve the description string provided by the plugins. To be used by clients.
public int getExecutionErrorCode ()
The client may retrieve the optionally-set execution error code after a failed call to
executeAction()
public String getExecutionErrorMessage ()
The client may retrieve the optionally-set execution error message after a failed call to
executeAction()
public Object getValue (String key)
Convenience method used to store any object. Objects may be stored by the client or the plugin.
Parameters
| key | object key |
|---|
Returns
- object or null
public void reset ()
Reset this action data object. Sub-classes should override this method and invoke it as well.
public void setDescription (String description)
Set the description string to be provided to the clients. To be used by plugins.
public void setExecutionError (int code, String msg)
The plugin may set an execution error code and message on a failed
executeAction()
invocation.
public void setExecutionErrorCode (int code)
The plugin may set an execution error code on a failed
executeAction()
invocation.
public void setExecutionErrorMessage (String msg)
The plugin may set an execution error message on a failed
executeAction()
invocation.
public void setValue (String key, Object value)
Convenience method used to retrieve previously stored objects.
Parameters
| key | object key |
|---|---|
| value | object value |