Ignore:
Timestamp:
04/29/13 12:31:22 (12 years ago)
Author:
pharms
Message:
  • improved java doc
Location:
trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc
Files:
9 edited

Legend:

Unmodified
Added
Removed

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IEventTask.java

    r1167 r1180  
    2020/** 
    2121 * <p> 
    22  * Event tasks represent events. They have no children and are therefore the leaf nodes of the 
    23  * task tree. They provide information about the event they represent. This includes the event 
     22 * Event tasks represent single events. They have no children and are therefore the leaf nodes of 
     23 * a task model. They provide information about the event they represent. This includes the event 
    2424 * type and the target. 
    2525 * </p> 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIteration.java

    r1146 r1180  
    1616 
    1717/** 
    18  * TODO comment 
     18 * <p> 
     19 * This temporal relationship defines that its single child may be executed zero or more times for 
     20 * fulfilling the task. This is most important for the parent node in the task model as this 
     21 * node may require that a specific subtask is executed several times. 
     22 * </p> 
    1923 *  
    20  * @version $Revision: $ $Date: 21.02.2012$ 
    21  * @author 2012, last modified by $Author: patrick$ 
     24 * @author Patrick Harms 
    2225 */ 
    2326public interface IIteration extends IMarkingTemporalRelationship { 
    2427 
    2528    /** 
    26      * 
     29     * <p> 
     30     * returns an exact copy of this temporal relationship. The clone has the same id. Its child 
     31     * is a clone of the child of the cloned task. A call on the method {@link #equals(ITask)} 
     32     * with the result of this method must return true. 
     33     * </p> 
     34     *  
     35     * @return as described 
    2736     */ 
    2837    public IIteration clone(); 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IMarkingTemporalRelationship.java

    r1146 r1180  
    1717/** 
    1818 * <p> 
    19  * TODO comment 
     19 * A marking temporal relationship defines a temporal information for exactly one node in the task 
     20 * model. I.e., it has only one child for which it defines a special execution characteristic. 
    2021 * </p> 
    2122 *  
    … …  
    2526 
    2627    /** 
    27      * 
     28     * <p> 
     29     * returns the task for which this relationship defines the execution characteristic. The 
     30     * task can be seen as the child node of this node. 
     31     * </p> 
     32     *  
     33     * @return as described 
    2834     */ 
    2935    public ITask getMarkedTask(); 
    3036 
    3137    /** 
    32      * 
     38     * <p> 
     39     * returns an exact copy of this temporal relationship. The clone has the same id. Its child 
     40     * is a clone of the child of the cloned task. A call on the method {@link #equals(ITask)} 
     41     * with the result of this method must return true. 
     42     * </p> 
     43     *  
     44     * @return as described 
    3345     */ 
    3446    public IMarkingTemporalRelationship clone(); 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptional.java

    r1146 r1180  
    1616 
    1717/** 
    18  * TODO comment 
     18 * <p> 
     19 * This temporal relationship defines that its single child may or may not be executed for 
     20 * fulfilling the task. This is most important for the parent node in the task model as this 
     21 * node may require that a specific subtask is optional. 
     22 * </p> 
    1923 *  
    20  * @version $Revision: $ $Date: 21.02.2012$ 
    21  * @author 2012, last modified by $Author: patrick$ 
     24 * @author Patrick Harms 
    2225 */ 
    2326public interface IOptional extends IMarkingTemporalRelationship { 
    2427 
    2528    /** 
    26      * 
     29     * <p> 
     30     * returns an exact copy of this temporal relationship. The clone has the same id. Its child 
     31     * is a clone of the child of the cloned task. A call on the method {@link #equals(ITask)} 
     32     * with the result of this method must return true. 
     33     * </p> 
     34     *  
     35     * @return as described 
    2736     */ 
    2837    public IOptional clone(); 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelection.java

    r1146 r1180  
    1616 
    1717/** 
    18  * TODO comment 
     18 * <p> 
     19 * This temporal relationship defines that only one of its children must be executed for 
     20 * fulfilling the represented task. 
     21 * </p> 
    1922 *  
    20  * @version $Revision: $ $Date: 21.02.2012$ 
    21  * @author 2012, last modified by $Author: patrick$ 
     23 * @author Patrick Harms 
    2224 */ 
    2325public interface ISelection extends IStructuringTemporalRelationship { 
    2426 
    2527    /** 
    26      * 
     28     * <p> 
     29     * returns an exact copy of this temporal relationship. The clone has the same id. Its children 
     30     * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} 
     31     * with the result of this method must return true. 
     32     * </p> 
     33     *  
     34     * @return as described 
    2735     */ 
    2836    public ISelection clone(); 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequence.java

    r1146 r1180  
    1616 
    1717/** 
    18  * TODO comment 
     18 * <p> 
     19 * This temporal relationship defines that its children must be executed in the order they are 
     20 * listed for fulfilling the represented task. 
     21 * </p> 
    1922 *  
    20  * @version $Revision: $ $Date: 21.02.2012$ 
    21  * @author 2012, last modified by $Author: patrick$ 
     23 * @author Patrick Harms 
    2224 */ 
    2325public interface ISequence extends IStructuringTemporalRelationship { 
    2426 
    2527    /** 
    26      * 
     28     * <p> 
     29     * returns an exact copy of this temporal relationship. The clone has the same id. Its children 
     30     * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} 
     31     * with the result of this method must return true. 
     32     * </p> 
     33     *  
     34     * @return as described 
    2735     */ 
    2836    public ISequence clone(); 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IStructuringTemporalRelationship.java

    r1146 r1180  
    1919/** 
    2020 * <p> 
    21  * TODO comment 
     21 * A structuring temporal relationship defines a temporal information for several nodes in the task 
     22 * model. I.e., it has several children and defines an execution order for them. 
    2223 * </p> 
    2324 *  
    … …  
    2728 
    2829    /** 
    29      * 
     30     * <p> 
     31     * returns the children of this temporal relationship. 
     32     * </p> 
     33     *  
     34     * @return as described 
    3035     */ 
    3136    public List<ITask> getChildren(); 
    3237 
    3338    /** 
    34      * 
     39     * <p> 
     40     * returns an exact copy of this temporal relationship. The clone has the same id. Its children 
     41     * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} 
     42     * with the result of this method must return true. 
     43     * </p> 
     44     *  
     45     * @return as described 
    3546     */ 
    3647    public IStructuringTemporalRelationship clone(); 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java

    r1167 r1180  
    2323 * and temporal relationships defining the event order. Tasks may especially refer to other tasks 
    2424 * to create task structures similar to trees. These structures fully define in which ways the 
    25  * events that form the task can occur. 
     25 * events that form the task can occur. However, the structure of a task is not necessarily a 
     26 * tree as task structures may be reused several times in larger scale task structures. 
    2627 * </p> 
    2728 *  

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITemporalRelationship.java

    r1146 r1180  
    1616 
    1717/** 
    18  * TODO comment 
     18 * <p> 
     19 * A temporal relationship is a node in a task model which is no leaf node. They are used to 
     20 * structure the tasks in a task model into useful orders. A temporal relationship defines through 
     21 * its type how its children can be executed to fulfill the task they represent themselves. E.g., 
     22 * the task of filling out a form can be subdivided into several subtasks for filling out the 
     23 * different elements of the. The task itself will define the order, in which the fill out process 
     24 * can and must be done. 
     25 * </p> 
    1926 *  
    20  * @version $Revision: $ $Date: 12.02.2012$ 
    21  * @author 2012, last modified by $Author: patrick$ 
     27 * @author Patrick Harms 
    2228 */ 
    2329public interface ITemporalRelationship extends ITask { 
    2430 
    2531    /** 
    26      * 
     32     * <p> 
     33     * returns an exact copy of this temporal relationship. The clone has the same id. Its children 
     34     * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} 
     35     * with the result of this method must return true. 
     36     * </p> 
     37     *  
     38     * @return as described 
    2739     */ 
    2840    public ITemporalRelationship clone(); 
Note: See TracChangeset for help on using the changeset viewer.