Thema dieser Dokumentation / Das FirstSpirit 5 Modul- / Komponenten-Modell / Von Gadgets, Aspects, Brokern und Agents / Arbeiten mit Referenzen / Das Interface Reference
Das Interface Reference
Package: de.espirit.firstspirit.access.editor.reference
Eine Abhängigkeit, die der Wert einer Eingabekomponente zu weiteren internen (z. B. einem Medium) oder externen Objekten (z. B. einer URL) besitzt, wird als Referenz bezeichnet. Die ausgehenden Referenzen einer Eingabekomponente (bzw. des dort enthaltenen Wertes) werden vom FirstSpirit Referenzmanager gesammelt und können innerhalb von FirstSpirit über den Referenzgraph visuell dargestellt werden.
Es wird zwischen folgenden Referenztypen unterschieden:
- Interne Referenzen: Dabei handelt es sich um eine Referenz zu einem FirstSpirit-Objekt vom Typ IDProvider (z. B. einer Seitenreferenz oder einem Medium) oder zu einem FirstSpirit-Objekt vom Typ Dataset innerhalb des gleichen FirstSpirit-Projekts.
- Remote-Referenzen: Dabei handelt es sich um eine Referenz zu einem verwandten FirstSpirit-Projekt. FirstSpirit unterstützt den Remote-Zugriff auf andere FirstSpirit-Projekte. Über den Remote-Zugriff kann innerhalb des aktuellen Projekts ein Element aus den Verwaltungsbereichen eines weiteren FirstSpirit-Projekts referenziert und angezeigt werden (z. B. "media:logo, remote:MainProject"). Die Objekte verbleiben dabei physikalisch im Remote-Projekt.
- Externe Referenzen: Dabei handelt es sich um eine Referenz zu einer externen Quelle, beispielsweise einer Website (z. B. "http://www.e-Spirit.com") oder einer Datenbank.
Das Interface bietet den Zugriff auf diese (und weitere) Methoden:
boolean isBroken(): Durch das Löschen von Elementen, die innerhalb des Projekts noch referenziert werden (oder auch durch einen defekten Projektimport), kann es zu ungültigen Referenzen im Projekt kommen. Ein FirstSpirit-Objekt wird über den UID (Unique Identifier) und den UID-Type (z. B. MEDIASTORE_LEAF) referenziert (entsprechende Methoden siehe FirstSpirit-Access-API, Interface IDProvider). Kann ein referenziertes Objekt über diese Parameter nicht mehr gefunden werden, liefert die Methode isBroken() true zurück. Die Methode prüft nur interne FirstSpirit-Referenzen und Remote-Referenzen, für externe Referenzen wird immer false zurückgeliefert.
boolean isRemote(): Sofern es sich um eine Referenz aus einem verwandten FirstSpirit-Projekt handelt, liefert die Methode true zurück.
Weitere Methoden siehe FirstSpirit-Access-API.