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