You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by an...@apache.org on 2004/03/01 12:04:17 UTC
cvs commit: cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl History.java
andreas 2004/03/01 03:04:17
Modified: src/blocks/workflow/java/org/apache/lenya/workflow
Condition.java
src/blocks/workflow/java/org/apache/lenya/workflow/impl
History.java
Log:
added more javadocs
Revision Changes Path
1.3 +9 -3 cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/Condition.java
Index: Condition.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/Condition.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Condition.java 1 Mar 2004 11:00:43 -0000 1.2
+++ Condition.java 1 Mar 2004 11:04:17 -0000 1.3
@@ -56,7 +56,13 @@
package org.apache.lenya.workflow;
/**
- * Workflow condition.
+ * <p>A condition can prevent a transition from firing,
+ * based on the current situation. Examples:</p>
+ * <ul>
+ * <li>Does the current user have a certain role on the current URL?</li>
+ * <li>Does a certain state variable have a certain value (e.g., is the document published)? (BooleanVariableCondition)<li>
+ * <li>Is the sun shining? (e.g., if the weather report may only be published on sunny days)</li>
+ * </ul>
*
* @author <a href="mailto:andreas@apache.org">Andreas Hartmann</a>
* @version $Id$
1.3 +11 -5 cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl/History.java
Index: History.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl/History.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- History.java 1 Mar 2004 10:36:22 -0000 1.2
+++ History.java 1 Mar 2004 11:04:17 -0000 1.3
@@ -82,10 +82,16 @@
import org.w3c.dom.Element;
/**
- * @author andreas
- *
- * To change the template for this generated type comment go to
- * Window>Preferences>Java>Code Generation>Code and Comments
+ * <p>The history of a workflow instance contains a list of all
+ * versions of the instance. A version contains
+ * </p>
+ * <ul>
+ * <li>the state,</li>
+ * <li>the event that caused the transition (omitted in the first version).</li>
+ * </ul>
+ *
+ * @author <a href="mailto:andreas@apache.org">Andreas Hartmann</a>
+ * @version $Id$
*/
public abstract class History implements WorkflowListener {
public static final String WORKFLOW_ATTRIBUTE = "workflow";