Ignore:
Timestamp:
05/27/13 14:54:09 (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/ITaskModel.java

    r1146 r1214  
    2020 
    2121/** 
    22  * TODO comment 
     22 * <p> 
     23 * This class represents a complete task model. A task model within AutoQUEST is usually generated 
     24 * based on user session. Therefore, the task model consists of the user sessions, the models 
     25 * of the identified tasks, as well as further information about the tasks (e.g. their 
     26 * occurrence count) for statistical processing. 
     27 * </p> 
    2328 *  
    24  * @version $Revision: $ $Date: 21.02.2012$ 
    25  * @author 2012, last modified by $Author: patrick$ 
     29 * @author 2012, Patrick Harms 
    2630 */ 
    2731public interface ITaskModel extends Cloneable, Serializable { 
    2832 
    2933    /** 
    30      * 
     34     * <p> 
     35     * returns the user sessions belonging to the model. The return value may be null in the case 
     36     * no user sessions are associated the the tasks in the model. 
     37     * </p> 
     38     *  
     39     * @return as described 
    3140     */ 
    3241    public List<IUserSession> getUserSessions(); 
    3342 
    3443    /** 
    35      * 
     44     * <p> 
     45     * returns the tasks belonging to the model. The return value must not be null. However, 
     46     * it may be an empty list, if the model is an empty model. 
     47     * </p> 
     48     *  
     49     * @return as described 
    3650     */ 
    3751    public Collection<ITask> getTasks(); 
    3852 
    3953    /** 
    40      * 
     54     * <p> 
     55     * returns additional info for the provided task. The method returns null, if the provided 
     56     * task does not belong to the model. 
     57     * </p> 
     58     *  
     59     * @return as described 
    4160     */ 
    4261    public ITaskInfo getTaskInfo(ITask task); 
    4362 
    4463    /** 
    45      * 
     64     * <p> 
     65     * creates a deep clone of the model including all tasks and user sessions. 
     66     * </p> 
     67     *  
     68     * @return as described 
    4669     */ 
    4770    public ITaskModel clone(); 
Note: See TracChangeset for help on using the changeset viewer.