Changeset 1214 for trunk/autoquest-core-tasktrees/src/main/java/de/ugoe

Timestamp:

05/27/13 14:54:09 (12 years ago)

Author:

pharms

Message:

• improved java doc

File:

• trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskModel.java (modified) (1 diff)

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

@@ -20 +20 @@
 
 /**
- * TODO comment
+ * <p>
+ * This class represents a complete task model. A task model within AutoQUEST is usually generated
+ * based on user session. Therefore, the task model consists of the user sessions, the models
+ * of the identified tasks, as well as further information about the tasks (e.g. their
+ * occurrence count) for statistical processing.
+ * </p>
  * 
- * @version $Revision: $ $Date: 21.02.2012$
- * @author 2012, last modified by $Author: patrick$
+ * @author 2012, Patrick Harms
  */
 public interface ITaskModel extends Cloneable, Serializable {
 
     /**
-     *
+     * <p>
+     * returns the user sessions belonging to the model. The return value may be null in the case
+     * no user sessions are associated the the tasks in the model.
+     * </p>
+     * 
+     * @return as described
      */
     public List<IUserSession> getUserSessions();
 
     /**
-     *
+     * <p>
+     * returns the tasks belonging to the model. The return value must not be null. However,
+     * it may be an empty list, if the model is an empty model.
+     * </p>
+     * 
+     * @return as described
      */
     public Collection<ITask> getTasks();
 
     /**
-     *
+     * <p>
+     * returns additional info for the provided task. The method returns null, if the provided
+     * task does not belong to the model.
+     * </p>
+     * 
+     * @return as described
      */
     public ITaskInfo getTaskInfo(ITask task);
 
     /**
-     *
+     * <p>
+     * creates a deep clone of the model including all tasks and user sessions.
+     * </p>
+     * 
+     * @return as described
      */
     public ITaskModel clone();