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 | |
---|
15 | package de.ugoe.cs.autoquest.tasktrees.treeifc; |
---|
16 | |
---|
17 | import java.util.List; |
---|
18 | |
---|
19 | import de.ugoe.cs.autoquest.eventcore.Event; |
---|
20 | |
---|
21 | // TODO: Auto-generated Javadoc |
---|
22 | /** |
---|
23 | * <p> |
---|
24 | * factory for the different task types |
---|
25 | * </p>. |
---|
26 | * |
---|
27 | * @author Patrick Harms |
---|
28 | */ |
---|
29 | public interface ITaskFactory { |
---|
30 | |
---|
31 | /** |
---|
32 | * <p> |
---|
33 | * creates a new event task with the given description |
---|
34 | * </p>. |
---|
35 | * |
---|
36 | * @param description the description for the represented events |
---|
37 | * @return the event task |
---|
38 | */ |
---|
39 | IEventTask createNewEventTask(String description); |
---|
40 | |
---|
41 | /** |
---|
42 | * <p> |
---|
43 | * creates a new empty iteration |
---|
44 | * </p>. |
---|
45 | * |
---|
46 | * @return the iteration |
---|
47 | */ |
---|
48 | IIteration createNewIteration(); |
---|
49 | |
---|
50 | /** |
---|
51 | * <p> |
---|
52 | * creates a new empty optional |
---|
53 | * </p>. |
---|
54 | * |
---|
55 | * @return the optional |
---|
56 | */ |
---|
57 | IOptional createNewOptional(); |
---|
58 | |
---|
59 | /** |
---|
60 | * <p> |
---|
61 | * creates a new empty selection |
---|
62 | * </p>. |
---|
63 | * |
---|
64 | * @return the selection |
---|
65 | */ |
---|
66 | ISelection createNewSelection(); |
---|
67 | |
---|
68 | /** |
---|
69 | * <p> |
---|
70 | * creates a new empty sequence |
---|
71 | * </p>. |
---|
72 | * |
---|
73 | * @return the sequence |
---|
74 | */ |
---|
75 | ISequence createNewSequence(); |
---|
76 | |
---|
77 | /** |
---|
78 | * <p> |
---|
79 | * creates a new task instance with the given task as its model representing |
---|
80 | * the provided event |
---|
81 | * </p>. |
---|
82 | * |
---|
83 | * @param task the model of the task instance to be created |
---|
84 | * @param event the event represented by the task instance |
---|
85 | * @return the task instance |
---|
86 | */ |
---|
87 | IEventTaskInstance createNewTaskInstance(IEventTask task, Event event); |
---|
88 | |
---|
89 | /** |
---|
90 | * <p> |
---|
91 | * creates a new task instance with the given iteration as its model |
---|
92 | * </p>. |
---|
93 | * |
---|
94 | * @param iteration the model of the task instance to be created |
---|
95 | * @return the task instance |
---|
96 | */ |
---|
97 | IIterationInstance createNewTaskInstance(IIteration iteration); |
---|
98 | |
---|
99 | /** |
---|
100 | * <p> |
---|
101 | * creates a new task instance with the given optional as its model |
---|
102 | * </p>. |
---|
103 | * |
---|
104 | * @param optional the model of the task instance to be created |
---|
105 | * @return the task instance |
---|
106 | */ |
---|
107 | IOptionalInstance createNewTaskInstance(IOptional optional); |
---|
108 | |
---|
109 | /** |
---|
110 | * <p> |
---|
111 | * creates a new task instance with the given selection as its model |
---|
112 | * </p>. |
---|
113 | * |
---|
114 | * @param selection the model of the task instance to be created |
---|
115 | * @return the task instance |
---|
116 | */ |
---|
117 | ISelectionInstance createNewTaskInstance(ISelection selection); |
---|
118 | |
---|
119 | /** |
---|
120 | * <p> |
---|
121 | * creates a new task instance with the given sequence as its model |
---|
122 | * </p>. |
---|
123 | * |
---|
124 | * @param sequence the model of the task instance to be created |
---|
125 | * @return the task instance |
---|
126 | */ |
---|
127 | ISequenceInstance createNewTaskInstance(ISequence sequence); |
---|
128 | |
---|
129 | /** |
---|
130 | * <p> |
---|
131 | * creates a task model based on the provided user sessions |
---|
132 | * </p>. |
---|
133 | * |
---|
134 | * @param userSessions the session based on which the task model shall be created |
---|
135 | * @return the task model |
---|
136 | */ |
---|
137 | ITaskModel createTaskModel(List<IUserSession> userSessions); |
---|
138 | |
---|
139 | /** |
---|
140 | * <p> |
---|
141 | * creates a new empty user session |
---|
142 | * </p>. |
---|
143 | * |
---|
144 | * @return the user session |
---|
145 | */ |
---|
146 | IUserSession createUserSession(); |
---|
147 | |
---|
148 | } |
---|