[2146] | 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.eventcore; |
---|
| 16 | |
---|
| 17 | import java.io.Serializable; |
---|
| 18 | |
---|
| 19 | /** |
---|
| 20 | * <p> |
---|
| 21 | * Common interface for event targets. An event target can, e.g., be an element of a GUI or Web |
---|
| 22 | * server or a VR. A concrete event-driven software platform can define its event targets through |
---|
| 23 | * the implementation of this interface. This type of event target differ from those of the parent |
---|
| 24 | * type in that they can build tree structures such as a {@link IHierarchicalEventTargetModel} |
---|
| 25 | * </p> |
---|
| 26 | * |
---|
| 27 | * @version 1.0 |
---|
| 28 | * @author Steffen Herbold |
---|
| 29 | */ |
---|
| 30 | public interface IHierarchicalEventTarget extends IEventTarget, Serializable { |
---|
| 31 | |
---|
| 32 | /** |
---|
| 33 | * <p> |
---|
| 34 | * Returns the parent of the event target. |
---|
| 35 | * </p> |
---|
| 36 | * |
---|
| 37 | * @return the parent |
---|
| 38 | */ |
---|
| 39 | public IHierarchicalEventTarget getParent(); |
---|
| 40 | |
---|
| 41 | /** |
---|
| 42 | * <p> |
---|
| 43 | * Returns the specification of the event target. |
---|
| 44 | * </p> |
---|
| 45 | * |
---|
| 46 | * @return the specification |
---|
| 47 | */ |
---|
| 48 | public IEventTargetSpec getSpecification(); |
---|
| 49 | |
---|
| 50 | /** |
---|
| 51 | * <p> |
---|
| 52 | * Updates the specification of a event target with another specification, e.g., to add further |
---|
| 53 | * known names of the event target. |
---|
| 54 | * </p> |
---|
| 55 | * |
---|
| 56 | * @param furtherSpec |
---|
| 57 | * additional specification |
---|
| 58 | */ |
---|
| 59 | public void updateSpecification(IEventTargetSpec furtherSpec); |
---|
| 60 | |
---|
| 61 | /** |
---|
| 62 | * <p> |
---|
| 63 | * returns the event target model to which this event target belongs (if any). |
---|
| 64 | * </p> |
---|
| 65 | * |
---|
| 66 | * @return as described |
---|
| 67 | */ |
---|
| 68 | public IHierarchicalEventTargetModel<? extends IHierarchicalEventTarget> getEventTargetModel(); |
---|
| 69 | |
---|
| 70 | /** |
---|
| 71 | * <p> |
---|
| 72 | * The {@link IHierarchicalEventTarget} that is passed by this function is equal to the current |
---|
| 73 | * event target and will hereafter be treated as such. |
---|
| 74 | * </p> |
---|
| 75 | * |
---|
| 76 | * @param equalTarget |
---|
| 77 | * event target that is equal |
---|
| 78 | */ |
---|
| 79 | public void addEqualEventTarget(IHierarchicalEventTarget equalTarget); |
---|
| 80 | } |
---|