com.jbbres.lib.actions.workflow
Interface WorkflowDefinitionNotification

All Known Implementing Classes:
AbstractWorkflowDefinitionNotification, WorkflowDefinitionMessageNotification

public interface WorkflowDefinitionNotification

A user notification raised during the workflow definition process.

Notifications can be used to provide information to the user while he/she is creating a workflow. Notifications are displayed at the top of the workflow panel.

Notifications are displayed until one of the following event occurs:

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

Method Summary
 void dismiss()
          This method is called when the message is dismissed by the user.
 javax.swing.Icon getIcon()
          Returns the notification icon.
 java.lang.String getMessage()
          Returns the notification message.
 boolean hasAssociatedOperation()
          Returns true if an operation is associated to the notification.
 boolean runAssociatedOperation()
          Executes the operation associated to the notification.
 

Method Detail

getMessage

java.lang.String getMessage()
Returns the notification message.

Returns:
the message

getIcon

javax.swing.Icon getIcon()
Returns the notification icon.

Returns:
the icon

hasAssociatedOperation

boolean hasAssociatedOperation()
Returns true if an operation is associated to the notification. An operation is a piece of code that is executed when the user click on the notification panel. The code can be defined in the runAssociatedOperation() method.

Returns:
true if an operation is associated to the notification.

runAssociatedOperation

boolean runAssociatedOperation()
Executes the operation associated to the notification. An operation is a piece of code that is executed when the user click on the notification panel.

Returns:
true if the operation has been successfully performed. In this case the notification will disappear. If the result of this method is false the notification stays visible.

dismiss

void dismiss()
This method is called when the message is dismissed by the user. If the message is removed for another reason (call of runAssociatedOperation(), change in the workflow definition...), this method is not called.



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.