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.temporalrelation; |
---|
16 | |
---|
17 | import java.util.List; |
---|
18 | |
---|
19 | import de.ugoe.cs.autoquest.tasktrees.treeifc.IUserSession; |
---|
20 | |
---|
21 | // TODO: Auto-generated Javadoc |
---|
22 | /** |
---|
23 | * <p> |
---|
24 | * A session scope rule is able to detected temporal relationships between task |
---|
25 | * instances of the sessions provided to the {@link #apply(List<IUserSession>)} |
---|
26 | * method. The rule creates temporal relationships between the tasks of the task |
---|
27 | * instances, i.e. substructures in the task tree, if it detects a temporal |
---|
28 | * relationship and instantiates the temporal relationships according to their |
---|
29 | * occurrences. |
---|
30 | * </p> |
---|
31 | * |
---|
32 | * @author Patrick Harms |
---|
33 | */ |
---|
34 | interface ISessionScopeRule extends ITemporalRelationshipRule { |
---|
35 | |
---|
36 | /** |
---|
37 | * <p> |
---|
38 | * Applies the rule to the given sessions. The returned rule application |
---|
39 | * result is null, if the rule can not be applied, i.e. it does not detect a |
---|
40 | * temporal relationship. It returns a rule application result with a status |
---|
41 | * {@link RuleApplicationStatus#RULE_APPLICATION_FINISHED} if the rule was |
---|
42 | * applied. The result contains all newly created tasks and task instances. |
---|
43 | * </p> |
---|
44 | * |
---|
45 | * @param sessions |
---|
46 | * the session on which the rule shall be applied |
---|
47 | * |
---|
48 | * @return the rule application result as described. |
---|
49 | */ |
---|
50 | RuleApplicationResult apply(List<IUserSession> sessions); |
---|
51 | |
---|
52 | } |
---|