Ignore:
Timestamp:
04/29/13 17:18:42 (11 years ago)
Author:
pharms
Message:
  • improved java doc
File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r1146 r1191  
    2121 
    2222/** 
    23  * TODO comment 
     23 * <p> 
     24 * factory for the different task types 
     25 * </p> 
    2426 *  
    25  * @version $Revision: $ $Date: 21.02.2012$ 
    26  * @author 2012, last modified by $Author: patrick$ 
     27 * @author Patrick Harms 
    2728 */ 
    2829public interface ITaskFactory { 
    2930 
    3031    /** 
     32     * <p> 
     33     * creates a new event task with the given type and target 
     34     * </p> 
    3135     *  
    32      * @param eventType 
    33      * @param eventTarget 
    34      * @return 
     36     * @param eventType   the type of the event represented by the task 
     37     * @param eventTarget the target of the event represented by the task 
     38     *  
     39     * @return the event task 
    3540     */ 
    3641    IEventTask createNewEventTask(IEventType eventType, IEventTarget eventTarget); 
    3742 
    3843    /** 
     44     * <p> 
     45     * creates a new empty sequence 
     46     * </p> 
    3947     *  
    40      * @return 
     48     * @return the sequence 
    4149     */ 
    4250    ISequence createNewSequence(); 
    4351 
    4452    /** 
     53     * <p> 
     54     * creates a new empty iteration 
     55     * </p> 
    4556     *  
    46      * @return 
     57     * @return the iteration 
    4758     */ 
    4859    IIteration createNewIteration(); 
    4960 
    5061    /** 
     62     * <p> 
     63     * creates a new empty optional 
     64     * </p> 
    5165     *  
    52      * @return 
     66     * @return the optional 
    5367     */ 
    5468    IOptional createNewOptional(); 
    5569 
    5670    /** 
     71     * <p> 
     72     * creates a new empty selection 
     73     * </p> 
    5774     *  
    58      * @return 
     75     * @return the selection 
    5976     */ 
    6077    ISelection createNewSelection(); 
    6178 
    6279    /** 
     80     * <p> 
     81     * creates a new task instance with the given task as its model 
     82     * </p> 
    6383     *  
    64      * @return 
     84     * @param task the model of the task instance to be created 
     85     *  
     86     * @return the task instance 
    6587     */ 
    6688    ITaskInstance createNewTaskInstance(ITask task); 
    6789 
    6890    /** 
    69      * 
    70      * @return 
     91     * <p> 
     92     * creates a new empty task instance list 
     93     * </p> 
     94     *  
     95     * @return the task instance list 
    7196     */ 
    7297    ITaskInstanceList createNewTaskInstanceList(); 
    7398 
    7499    /** 
     100     * <p> 
     101     * creates a new empty user session 
     102     * </p> 
    75103     *  
    76      * @return 
     104     * @return the user session 
    77105     */ 
    78106    IUserSession createUserSession(); 
    79107 
    80108    /** 
     109     * <p> 
     110     * creates a task model based on the provided user sessions 
     111     * </p> 
    81112     *  
    82      * @param rootSequence 
    83      * @return 
     113     * @param userSessions the session based on which the task model shall be created 
     114     *  
     115     * @return the task model 
    84116     */ 
    85117    ITaskModel createTaskModel(List<IUserSession> userSessions); 
Note: See TracChangeset for help on using the changeset viewer.