+ * Event tasks represent events. They have no children and are therefore the leaf nodes of the + * task tree. They provide information about the event they represent. This includes the event + * type and the target. + *
* - * @version $Revision: $ $Date: $ - * @author 2011, last modified by $Author: $ + * @author Patrick Harms */ public interface IEventTask extends ITask { /** - * @return Returns the event type. + *+ * return the type of the event represented by this task + *
+ * + * @return as described */ public IEventType getEventType(); /** - * @return Returns the event target. + *+ * return the target of the event represented by this task + *
+ * + * @return as described */ public IEventTarget getEventTarget(); /** - * + *+ * returns a clone of this task, i.e. another event task being identical to this. The event + * type and target are not cloned but reused. + *
+ * + * @return as described */ public IEventTask clone(); Index: trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java =================================================================== --- trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java (revision 1157) +++ trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java (revision 1167) @@ -19,5 +19,9 @@ /** *- * TODO comment + * A task represents a model for events that occur if the user interacts with a software for + * achieving a specific goal. A task can be a single event or a complex structure of events + * and temporal relationships defining the event order. Tasks may especially refer to other tasks + * to create task structures similar to trees. These structures fully define in which ways the + * events that form the task can occur. *
* @@ -27,32 +31,61 @@ /** - * + *+ * every task is assigned a unique id which is returned by this method. The id is unique for + * the current runtime. + *
+ * + * @return as described */ public int getId(); /** - * + *+ * returns a human readable description for task. + *
+ * + * @return as described */ public String getDescription(); /** - * + *+ * checks whether this task is equal to another one. Task equality is only given, if two + * tasks have the same id. This means, that this method must only return true if the other + * task is either the same object or a clone of it. + *
+ * + * @return as described */ public boolean equals(ITask task); /** - * + *+ * returns a hash code for the task, which is usually the id returned by {@link #getId()}. + *
+ * + * @return as described */ public int hashCode(); /** - * + *+ * returns an exact copy of this task. The clone has the same id. If the task has + * children, they are cloned as well. A call on the method {@link #equals(ITask)} with the + * result of this method must return true. + *
+ * + * @return as described */ public ITask clone(); /** - * + *+ * implements the visitor pattern to be able to process tasks and their children. + *
+ * + * @param visitor the visitor used to process the task */ - public void accept(ITaskVisitor visitor); + public void accept(ITaskVisitor visitor); }