[Yanel-commits] rev 55058 - public/yanel/trunk/src/core/java/org/wyona/yanel/core/workflow

[michi at wyona.com]

Author: michi
Date: 2010-11-30 08:54:23 +0100 (Tue, 30 Nov 2010)
New Revision: 55058

Modified:
   public/yanel/trunk/src/core/java/org/wyona/yanel/core/workflow/Action.java
Log:
javadoc added

Modified: public/yanel/trunk/src/core/java/org/wyona/yanel/core/workflow/Action.java
===================================================================
--- public/yanel/trunk/src/core/java/org/wyona/yanel/core/workflow/Action.java	2010-11-29 22:41:22 UTC (rev 55057)
+++ public/yanel/trunk/src/core/java/org/wyona/yanel/core/workflow/Action.java	2010-11-30 07:54:23 UTC (rev 55058)
@@ -17,11 +17,22 @@
 
 import org.wyona.yanel.core.api.attributes.WorkflowableV1;
 
+/**
+ * Action interface in order to develop a custom action which is executed during a workflow transition
+ */
 public interface Action {
 
-    void execute(WorkflowableV1 workflowable, Workflow workflow,
-            String revision) throws WorkflowException;
+    /**
+     * Execute action
+     * @param workflowable A Workflowable resource to which the action is associated with
+     * @param workflow Workflow instance
+     * @param revision Revision of resource
+     */
+    void execute(WorkflowableV1 workflowable, Workflow workflow, String revision) throws WorkflowException;
 
+    /**
+     * Set "configuration parameters" (e.g. E-Mail address). Also see {@link WorkflowBuilder}.
+     * @param expression "Parameters"
+     */
     void setExpression(String expression) throws WorkflowException;
-
-}
\ No newline at end of file
+}