com.jbbres.lib.actions.workflow
Interface WorkflowListener

All Superinterfaces:
java.util.EventListener

public interface WorkflowListener
extends java.util.EventListener

The listener interface for receiving Workflow events.

The class that is interested in processing an Workflow event implements this interface, and the object created with that class is registered with the Workflow, using the addWorkflowListener(WorkflowListener) method.
When a Workflow event occurs, that object's corresponding method is invoked.

Since:
1.0.0
Version:
1.0.0
Author:
Jean-Baptiste Bres

Method Summary
 void workflowAskedForInterruption(WorkflowEvent e)
          Invoked when the workflow is asked to stop.
 void workflowAskedForSuspension(WorkflowEvent e)
          Invoked when the workflow ask for suspension.
 void workflowEnded(WorkflowEvent e)
          Invoked when the workflow execution ends.
 void workflowResumed(WorkflowEvent e)
          Invoked when the workflow is resumed by calling the workflow' Workflow.resume() method.
 void workflowStarted(WorkflowEvent e)
          Invoked when the workflow execution begins.
 void workflowSuspended(WorkflowEvent e)
          Invoked when the workflow is suspended.
 

Method Detail

workflowStarted

void workflowStarted(WorkflowEvent e)
Invoked when the workflow execution begins.

Parameters:
e - - the event

workflowEnded

void workflowEnded(WorkflowEvent e)
Invoked when the workflow execution ends.

When the Workflow.interrupt() method is called, the workflow does not stop immediately. It first finishes to run the current action and then stop.
This method is invoked when the workflow effectively stop, contrary to workflowAskedForInterruption(WorkflowEvent), which is invoked when the Workflow.interrupt() method is called.

Parameters:
e - - the event
See Also:
workflowAskedForInterruption(WorkflowEvent)

workflowAskedForInterruption

void workflowAskedForInterruption(WorkflowEvent e)
Invoked when the workflow is asked to stop.

When the Workflow.interrupt() method is called, the workflow does not stop immediately. It first finishes to run the current action and then stop.
This method is invoked when the interrupt() method is called, contrary to workflowEnded(WorkflowEvent), which is invoked when the workflow really ends.

Parameters:
e - - the event
See Also:
workflowEnded(WorkflowEvent)

workflowSuspended

void workflowSuspended(WorkflowEvent e)
Invoked when the workflow is suspended.

When the Workflow.pause() method is called, the workflow does not pause immediately. It first finishes to run the current action and then pause.
This method is invoked when the workflow enters in pause, contrary to #workflowAskForSuspension(WorkflowEvent), which is invoked when the pause() method is called.

Parameters:
e - - the event
See Also:
workflowAskedForSuspension(WorkflowEvent)

workflowAskedForSuspension

void workflowAskedForSuspension(WorkflowEvent e)
Invoked when the workflow ask for suspension.

When the Workflow.pause() method is called, the workflow does not pause immediately. It first finishes to run the current action and then pause.
This method is invoked when the pause() method is called, contrary to workflowSuspended(WorkflowEvent), which is invoked when the workflow really enters in pause.

Parameters:
e - - the event
See Also:
workflowSuspended(WorkflowEvent)

workflowResumed

void workflowResumed(WorkflowEvent e)
Invoked when the workflow is resumed by calling the workflow' Workflow.resume() method.

Parameters:
e - - the event


To file bugs or suggest feature enhancements, visit the app.jbbres.com Bug Reporter website.

Additional documentation available online at http://app.jbbres.com/actions/developers.

Copyright � 2009-2011 app.jbbres.com. All Rights Reserved.