- * Event tasks represent events. They have no children and are therefore the leaf nodes of the - * task tree. They provide information about the event they represent. This includes the event + * Event tasks represent single events. They have no children and are therefore the leaf nodes of + * a task model. They provide information about the event they represent. This includes the event * type and the target. *
Index: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIteration.java =================================================================== --- trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIteration.java (revision 1177) +++ trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIteration.java (revision 1180) @@ -16,13 +16,22 @@ /** - * TODO comment + *+ * This temporal relationship defines that its single child may be executed zero or more times for + * fulfilling the task. This is most important for the parent node in the task model as this + * node may require that a specific subtask is executed several times. + *
* - * @version $Revision: $ $Date: 21.02.2012$ - * @author 2012, last modified by $Author: patrick$ + * @author Patrick Harms */ public interface IIteration extends IMarkingTemporalRelationship { /** - * + *+ * returns an exact copy of this temporal relationship. The clone has the same id. Its child + * is a clone of the child of the cloned task. A call on the method {@link #equals(ITask)} + * with the result of this method must return true. + *
+ * + * @return as described */ public IIteration clone(); Index: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IMarkingTemporalRelationship.java =================================================================== --- trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IMarkingTemporalRelationship.java (revision 1177) +++ trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IMarkingTemporalRelationship.java (revision 1180) @@ -17,5 +17,6 @@ /** *- * TODO comment + * A marking temporal relationship defines a temporal information for exactly one node in the task + * model. I.e., it has only one child for which it defines a special execution characteristic. *
* @@ -25,10 +26,21 @@ /** - * + *+ * returns the task for which this relationship defines the execution characteristic. The + * task can be seen as the child node of this node. + *
+ * + * @return as described */ public ITask getMarkedTask(); /** - * + *+ * returns an exact copy of this temporal relationship. The clone has the same id. Its child + * is a clone of the child of the cloned task. A call on the method {@link #equals(ITask)} + * with the result of this method must return true. + *
+ * + * @return as described */ public IMarkingTemporalRelationship clone(); Index: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptional.java =================================================================== --- trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptional.java (revision 1177) +++ trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptional.java (revision 1180) @@ -16,13 +16,22 @@ /** - * TODO comment + *+ * This temporal relationship defines that its single child may or may not be executed for + * fulfilling the task. This is most important for the parent node in the task model as this + * node may require that a specific subtask is optional. + *
* - * @version $Revision: $ $Date: 21.02.2012$ - * @author 2012, last modified by $Author: patrick$ + * @author Patrick Harms */ public interface IOptional extends IMarkingTemporalRelationship { /** - * + *+ * returns an exact copy of this temporal relationship. The clone has the same id. Its child + * is a clone of the child of the cloned task. A call on the method {@link #equals(ITask)} + * with the result of this method must return true. + *
+ * + * @return as described */ public IOptional clone(); Index: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelection.java =================================================================== --- trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelection.java (revision 1177) +++ trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelection.java (revision 1180) @@ -16,13 +16,21 @@ /** - * TODO comment + *+ * This temporal relationship defines that only one of its children must be executed for + * fulfilling the represented task. + *
* - * @version $Revision: $ $Date: 21.02.2012$ - * @author 2012, last modified by $Author: patrick$ + * @author Patrick Harms */ public interface ISelection extends IStructuringTemporalRelationship { /** - * + *+ * returns an exact copy of this temporal relationship. The clone has the same id. Its children + * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} + * with the result of this method must return true. + *
+ * + * @return as described */ public ISelection clone(); Index: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequence.java =================================================================== --- trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequence.java (revision 1177) +++ trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequence.java (revision 1180) @@ -16,13 +16,21 @@ /** - * TODO comment + *+ * This temporal relationship defines that its children must be executed in the order they are + * listed for fulfilling the represented task. + *
* - * @version $Revision: $ $Date: 21.02.2012$ - * @author 2012, last modified by $Author: patrick$ + * @author Patrick Harms */ public interface ISequence extends IStructuringTemporalRelationship { /** - * + *+ * returns an exact copy of this temporal relationship. The clone has the same id. Its children + * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} + * with the result of this method must return true. + *
+ * + * @return as described */ public ISequence clone(); Index: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IStructuringTemporalRelationship.java =================================================================== --- trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IStructuringTemporalRelationship.java (revision 1177) +++ trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IStructuringTemporalRelationship.java (revision 1180) @@ -19,5 +19,6 @@ /** *- * TODO comment + * A structuring temporal relationship defines a temporal information for several nodes in the task + * model. I.e., it has several children and defines an execution order for them. *
* @@ -27,10 +28,20 @@ /** - * + *+ * returns the children of this temporal relationship. + *
+ * + * @return as described */ public List+ * returns an exact copy of this temporal relationship. The clone has the same id. Its children + * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} + * with the result of this method must return true. + *
+ * + * @return as described */ public IStructuringTemporalRelationship clone(); Index: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java =================================================================== --- trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java (revision 1177) +++ trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java (revision 1180) @@ -23,5 +23,6 @@ * and temporal relationships defining the event order. Tasks may especially refer to other tasks * to create task structures similar to trees. These structures fully define in which ways the - * events that form the task can occur. + * events that form the task can occur. However, the structure of a task is not necessarily a + * tree as task structures may be reused several times in larger scale task structures. * * Index: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITemporalRelationship.java =================================================================== --- trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITemporalRelationship.java (revision 1177) +++ trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITemporalRelationship.java (revision 1180) @@ -16,13 +16,25 @@ /** - * TODO comment + *+ * A temporal relationship is a node in a task model which is no leaf node. They are used to + * structure the tasks in a task model into useful orders. A temporal relationship defines through + * its type how its children can be executed to fulfill the task they represent themselves. E.g., + * the task of filling out a form can be subdivided into several subtasks for filling out the + * different elements of the. The task itself will define the order, in which the fill out process + * can and must be done. + *
* - * @version $Revision: $ $Date: 12.02.2012$ - * @author 2012, last modified by $Author: patrick$ + * @author Patrick Harms */ public interface ITemporalRelationship extends ITask { /** - * + *+ * returns an exact copy of this temporal relationship. The clone has the same id. Its children + * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} + * with the result of this method must return true. + *
+ * + * @return as described */ public ITemporalRelationship clone();