[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.temporalrelation; |
---|
[439] | 16 | |
---|
[1294] | 17 | import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance; |
---|
[439] | 18 | |
---|
| 19 | /** |
---|
[809] | 20 | * <p> |
---|
[1294] | 21 | * a task instance scope rule is able to detected temporal relationships between the children of |
---|
| 22 | * a task instance provided to the {@link #apply(ITaskInstance)} method. A rule creates temporal |
---|
[1146] | 23 | * relationships between the task instances, i.e. substructures in the task tree, if |
---|
| 24 | * it detects a temporal relationship and instantiates the temporal relationships accordingly. |
---|
[809] | 25 | * </p> |
---|
[439] | 26 | * |
---|
[809] | 27 | * @author Patrick Harms |
---|
[439] | 28 | */ |
---|
[1294] | 29 | interface ITaskInstanceScopeRule extends ITemporalRelationshipRule { |
---|
[439] | 30 | |
---|
| 31 | /** |
---|
[809] | 32 | * <p> |
---|
[1294] | 33 | * applies the rule to the given task instance. The returned rule application result is null, |
---|
[1146] | 34 | * if the rule can not be applied, i.e. it does not detect a temporal relationship. It returns a |
---|
| 35 | * rule application result with a status {@link RuleApplicationStatus#RULE_APPLICATION_FINISHED} |
---|
| 36 | * if the rule was applied. The result contains all newly created parent tasks and task instances. |
---|
[809] | 37 | * </p> |
---|
| 38 | * |
---|
[1294] | 39 | * @param taskInstance the task instances to apply the rule on |
---|
[809] | 40 | * |
---|
| 41 | * @return the rule application result as described. |
---|
[439] | 42 | */ |
---|
[1294] | 43 | RuleApplicationResult apply(ITaskInstance taskInstance); |
---|
[439] | 44 | |
---|
| 45 | } |
---|