|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.EventObject com.jbbres.lib.actions.elements.ActionExecutionEvent
public class ActionExecutionEvent
A semantic event which indicates that an event related to the action execution occured.
This event is generated by an action (via its ActionService
) during
one of the stage of its execution (such as at the beginning or the end).
The event is passed to every ActionExecutionListener
object that
registered to receive such events using the service
addExecutionListener(ActionExecutionListener)
method.
The object that implements the ActionExecutionListener
interface
gets this ActionExecutionEvent
when the event occurs.
ActionService.addExecutionListener(ActionExecutionListener)
,
ActionExecutionListener
,
Serialized FormField Summary | |
---|---|
static int |
ACTION_FAILED
The action has failed during its execution. |
static int |
ACTION_IN_PROGRESS
The action is currently executing. |
static int |
ACTION_SUCCEED
The action has been processed successfully and came to its end. |
Constructor Summary | |
---|---|
ActionExecutionEvent(ActionService source)
Instantiates a new event. |
|
ActionExecutionEvent(ActionService source,
int status)
Instantiates a new event. |
|
ActionExecutionEvent(ActionService source,
int status,
java.lang.Object input,
Parameters parameters,
java.lang.Object result)
Instantiates a new event. |
|
ActionExecutionEvent(ActionService source,
int status,
java.lang.Object input,
Parameters parameters,
java.lang.Object result,
java.lang.Throwable exception)
Instantiates a new event. |
|
ActionExecutionEvent(ActionService source,
java.lang.Object input,
Parameters parameters)
Instantiates a new event. |
Method Summary | |
---|---|
Action |
getAction(Workflow withinWorkflow)
Returns the Action that has raised the event. |
ActionService |
getActionService()
Returns the ActionService that has raised the event. |
java.lang.Throwable |
getException()
Returns the exception that has cause the action to stop, if any. |
Parameters |
getExecutionParameters()
Returns the Parameters object that has been given for the
action execution. |
java.lang.Object |
getInputObject()
Returns the object that has been given as an input for the action execution. |
java.lang.Object |
getOutputObject()
Returns the object that has been generated as an output for the action execution. |
int |
getStatus()
Returns the action status. |
Methods inherited from class java.util.EventObject |
---|
getSource, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ACTION_SUCCEED
public static final int ACTION_IN_PROGRESS
public static final int ACTION_FAILED
Constructor Detail |
---|
public ActionExecutionEvent(ActionService source)
source
- - the ActionService
source of the eventActionExecutionEvent(ActionService, int, Object, Parameters,
Object, Throwable)
public ActionExecutionEvent(ActionService source, int status)
source
- - the ActionService
source of the eventstatus
- - the status of the eventActionExecutionEvent(ActionService, int, Object, Parameters,
Object, Throwable)
public ActionExecutionEvent(ActionService source, java.lang.Object input, Parameters parameters)
source
- - the ActionService
source of the eventinput
- - the input object of the action's executionparameters
- - the parameters of the action's executionActionExecutionEvent(ActionService, int, Object, Parameters,
Object, Throwable)
public ActionExecutionEvent(ActionService source, int status, java.lang.Object input, Parameters parameters, java.lang.Object result)
source
- - the ActionService
source of the eventstatus
- - the status of the eventinput
- - the input object of the action's executionparameters
- - the parameters of the action's executionresult
- - the output object of the action's executionActionExecutionEvent(ActionService, int, Object, Parameters,
Object, Throwable)
public ActionExecutionEvent(ActionService source, int status, java.lang.Object input, Parameters parameters, java.lang.Object result, java.lang.Throwable exception)
source
- - the ActionService
source of the eventstatus
- - the status of the eventinput
- - the input object of the action's executionparameters
- - the parameters of the action's executionresult
- - the output object of the action's executionexception
- - the exception raised during the actionMethod Detail |
---|
public ActionService getActionService()
ActionService
that has raised the event.
public Action getAction(Workflow withinWorkflow)
Action
that has raised the event.
withinWorkflow
- - The workflow containing the action. By conception, the
source of this event is an ActionService
, not an
Action
. The ActionService
object
does not reference the Action
it is associated
to. To iddentify the action, this method checks all the action
within the given workflow and compare their services to the
source of this event.
Action
that has raised the event.public int getStatus()
public java.lang.Object getInputObject()
If no object has been given as an input, or if the action does not accept
input object, this function return null
.
public Parameters getExecutionParameters()
Parameters
object that has been given for the
action execution.null
.
Parameters
object that has been given for the
action executionpublic java.lang.Object getOutputObject()
null
.
public java.lang.Throwable getException()
null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |