[1113] | 1 | // Copyright 2012 Georg-August-Universität Göttingen, Germany |
---|
| 2 | // |
---|
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
---|
| 4 | // you may not use this file except in compliance with the License. |
---|
| 5 | // You may obtain a copy of the License at |
---|
| 6 | // |
---|
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
---|
| 8 | // |
---|
| 9 | // Unless required by applicable law or agreed to in writing, software |
---|
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
---|
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
| 12 | // See the License for the specific language governing permissions and |
---|
| 13 | // limitations under the License. |
---|
| 14 | |
---|
[922] | 15 | package de.ugoe.cs.autoquest.tasktrees.treeifc; |
---|
[439] | 16 | |
---|
[1146] | 17 | import java.io.Serializable; |
---|
| 18 | import java.util.Collection; |
---|
| 19 | import java.util.List; |
---|
[439] | 20 | |
---|
| 21 | /** |
---|
[1214] | 22 | * <p> |
---|
| 23 | * This class represents a complete task model. A task model within AutoQUEST is usually generated |
---|
[1423] | 24 | * based on user sessions. Therefore, the task model consists of the user sessions, the models |
---|
[1214] | 25 | * of the identified tasks, as well as further information about the tasks (e.g. their |
---|
| 26 | * occurrence count) for statistical processing. |
---|
| 27 | * </p> |
---|
[439] | 28 | * |
---|
[1214] | 29 | * @author 2012, Patrick Harms |
---|
[439] | 30 | */ |
---|
[1146] | 31 | public interface ITaskModel extends Cloneable, Serializable { |
---|
[439] | 32 | |
---|
[557] | 33 | /** |
---|
[1214] | 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 |
---|
[557] | 40 | */ |
---|
[1146] | 41 | public List<IUserSession> getUserSessions(); |
---|
[439] | 42 | |
---|
[557] | 43 | /** |
---|
[1214] | 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 |
---|
[557] | 50 | */ |
---|
[1146] | 51 | public Collection<ITask> getTasks(); |
---|
[439] | 52 | |
---|
[557] | 53 | /** |
---|
[1214] | 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 |
---|
[557] | 60 | */ |
---|
[1146] | 61 | public ITaskInfo getTaskInfo(ITask task); |
---|
| 62 | |
---|
| 63 | /** |
---|
[1214] | 64 | * <p> |
---|
[1423] | 65 | * returns a list of all metrics calculated by this model for the tasks and stored in the |
---|
| 66 | * respective task infos |
---|
| 67 | * </p> |
---|
| 68 | * |
---|
| 69 | * @return as described |
---|
| 70 | */ |
---|
| 71 | public TaskMetric[] getAllMetrics(); |
---|
| 72 | |
---|
| 73 | /** |
---|
| 74 | * <p> |
---|
[1214] | 75 | * creates a deep clone of the model including all tasks and user sessions. |
---|
| 76 | * </p> |
---|
| 77 | * |
---|
| 78 | * @return as described |
---|
[1146] | 79 | */ |
---|
| 80 | public ITaskModel clone(); |
---|
[1423] | 81 | |
---|
[439] | 82 | } |
---|