Changeset 1177 for trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IUserSession.java

Timestamp:

04/25/13 16:59:20 (11 years ago)

Author:

pharms

Message:

• improved java doc

File:

• trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IUserSession.java (modified) (2 diffs)

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

@@ -19 +19 @@
 /**
  * <p>
- * TODO comment
+ * A user session represents task executions, i.e. a task instances of a specific user that were
+ * executed in a coherent manner. Therefore, they are an ordered list of task instances where
+ * the order denotes the order of the task executions.
  * </p>
  * 
@@ -27 +29 @@
 
     /**
-     *
+     * <p>
+     * returns the list of task instances executed in the represented session.
+     * </p>
+     * 
+     * @return as described
      */
     public List<ITaskInstance> getExecutedTasks();
     
     /**
-     *
+     * <p>
+     * compares the user session with another one. Two user sessions are only equal, if they
+     * contain the same number of task instances and if each task instance at each position is
+     * equal to the respective other session. 
+     * </p>
+     * 
+     * @param userSession the session to compare the session to
+     * 
+     * @return true if both sessions are equal, false else
      */
     public boolean equals(IUserSession userSession);
 
     /**
-     *
+     * <p>
+     * returns a hash code for the session to be able to store the session in a hash map.
+     * </p>
+     * 
+     * @return as described
      */
     public int hashCode();
 
     /**
-     *
+     * <p>
+     * clones a user session by creating exact clones of each contained instance in their order
+     * </p>
+     * 
+     * @return a clone of the session
      */
     public IUserSession clone();