Datentyp TargetReference
Wertebereich des Datentyps TargetReference
Für die Bearbeitung von Werten, die eine Referenz auf ein FirstSpirit-Objekt repräsentieren, stellt FirstSpirit den Datentyp TargetReference zur Verfügung.
Der Datentyp TargetReference liefert eine Referenz zu einem beliebigen FirstSpirit-Objekt zurück. Der Typ des referenzierten Objekts ist dabei nicht festgelegt: es können Referenzen zu Medien (Bilder und Dateien), zu Dokumentengruppen, zu Ordnern, zu Seiten (Inhalte-Verwaltung), zu Seitenreferenzen (Struktur-Verwaltung) und Content2-Objekten (Datenquellen-Verwaltung) sowie zu jedem anderen Verwaltungsbereich ausgewählt sein.
Weitere Informationen zum Datentyp TargetReference siehe API-Dokumentation:
de.espirit.firstspirit.access.editor.value.TargetReference
Definition über die Standard-Eingabekomponenten
Die Eingabekomponente FS_REFERENCE dient zur Aufnahme von Referenzen auf FirstSpirit-Objekte (Seitenreferenzen, Seiten aus der Inhalte-Verwaltung, Medien usw.).
Diese Eingabekomponente liefert dann beim Zugriff auf den gespeicherten Wert mithilfe einer $CMS_VALUE(...)$-Anweisung den Datentyp TargetReference zurück.
Methoden auf TargetReference-Objekten
In der unten angegebenen Tabellen werden alle Methoden aufgelistet, die auf Objekten von Datentyp TargetReference aufgerufen werden können:
Objekt wird von folgenden Formular-Objekten erzeugt: |
---|
FS_REFERENCE |
compareTo(Comparable)
Methodenname |
Rückgabetyp |
Verfügbar seit |
compareTo(Comparable) |
int |
|
Übersicht
equals(Object)
Methodenname |
Rückgabetyp |
Verfügbar seit |
equals(Object) |
boolean |
|
Übersicht
get
Methodenname |
Rückgabetyp |
Verfügbar seit |
get |
IDProvider |
|
Übersicht
getClass
Die Methode .getClass() (in Bean-Syntax: .class) liefert die Klasse des aufrufendes Objektes zurück (vgl. java.lang.Class).
Aufruf:
$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$
Ausgabe:
java.lang.String
Methodenname |
Rückgabetyp |
Verfügbar seit |
getClass |
Class |
|
Übersicht
getContent
Methodenname |
Rückgabetyp |
Verfügbar seit |
getContent |
Content2 |
|
Übersicht
getDocumentGroup
Methodenname |
Rückgabetyp |
Verfügbar seit |
getDocumentGroup |
DocumentGroup |
|
Übersicht
getLanguage
Methodenname |
Rückgabetyp |
Verfügbar seit |
getLanguage |
Language |
|
Übersicht
getMedia
Methodenname |
Rückgabetyp |
Verfügbar seit |
getMedia |
Media |
|
Übersicht
getPage
Methodenname |
Rückgabetyp |
Verfügbar seit |
getPage |
Page |
|
Übersicht
getPageRef
Methodenname |
Rückgabetyp |
Verfügbar seit |
getPageRef |
PageRef |
|
Übersicht
getRemoteSymName
Methodenname |
Rückgabetyp |
Verfügbar seit |
getRemoteSymName |
String |
|
Übersicht
getSection
Methodenname |
Rückgabetyp |
Verfügbar seit |
getSection |
Section |
|
Übersicht
getSectionName
Methodenname |
Rückgabetyp |
Verfügbar seit |
getSectionName |
String |
|
Übersicht
getStoreType
Methodenname |
Rückgabetyp |
Verfügbar seit |
getStoreType |
Store$Type |
|
Übersicht
getUid
Methodenname |
Rückgabetyp |
Verfügbar seit |
getUid |
String |
|
Übersicht
getUidType
Übersicht
isCase(Object)
Methodenname |
Rückgabetyp |
Verfügbar seit |
isCase(Object) |
boolean |
|
Übersicht
isEmpty
Die Methode .isEmpty() (in Bean-Syntax: .isEmpty) prüft, ob ein Ausdruck bzw. Objekt leer ist, z.B. storeElement.isEmpty(). Das Ergebnis der semantischen Prüfung hängt vom Ausdruck bzw. Objekt ab, z.B. eine Zeichenkette ist dann leer, wenn sie kein Zeichen enthält. Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt wann es leer ist. Der Datentyp DomElement enthält beispielsweise immer ein leeres Dokument, ist also nie null. Die Prüfung einer leeren DOM-Editor-Eingabekomponente mit der Methode .isNull() liefert daher den Wert false, während die Prüfung der Komponente auf .isEmpty() den Wert true liefern würde.
Die Methode .isEmpty() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt leer ist und false (=unwahr) wenn nicht.
Methodenname |
Rückgabetyp |
Verfügbar seit |
isEmpty |
boolean |
|
Übersicht
isNull
Die Methode .isNull() (in Bean-Syntax: .isNull) prüft, ob ein Ausdruck bzw. Objekt Null ist, z.B. storeElement.isNull(). Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt wann es null ist. Der Datentyp DomElement enthält beispielsweise immer ein leeres Dokument, ist also nie null. Die Prüfung einer leeren DOM-Editor-Eingabekomponente mit der Methode .isNull() liefert daher den Wert false, während die Prüfung der Komponente auf .isEmpty() den Wert true liefern würde.
Die Methode .isNull() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt Null ist und false (=unwahr) wenn nicht.
Methodenname |
Rückgabetyp |
Verfügbar seit |
isNull |
boolean |
|
Übersicht
loadSection(Page, String)
Methodenname |
Rückgabetyp |
Verfügbar seit |
loadSection(Page, String) |
Section |
|
Übersicht
print
Methodenname |
Rückgabetyp |
Verfügbar seit |
print |
void |
|
Übersicht
resetTo(IDProvider, String)
Methodenname |
Rückgabetyp |
Verfügbar seit |
resetTo(IDProvider, String) |
void |
|
Übersicht
set(IDProvider)
Methodenname |
Rückgabetyp |
Verfügbar seit |
set(IDProvider) |
void |
|
Übersicht
set(String, Object)
Methodenname |
Rückgabetyp |
Verfügbar seit |
set(String, Object) |
Object |
|
Übersicht
setRemoteSymName(String)
Methodenname |
Rückgabetyp |
Verfügbar seit |
setRemoteSymName(String) |
void |
|
Übersicht
setSection(Section)
Methodenname |
Rückgabetyp |
Verfügbar seit |
setSection(Section) |
void |
|
Übersicht
setSectionName(String)
Methodenname |
Rückgabetyp |
Verfügbar seit |
setSectionName(String) |
void |
|
Übersicht
setUid(String)
Methodenname |
Rückgabetyp |
Verfügbar seit |
setUid(String) |
void |
|
Übersicht
setUidType(IDProvider$UidType)
Methodenname |
Rückgabetyp |
Verfügbar seit |
setUidType(IDProvider$UidType) |
void |
|
Übersicht
toJson
Convert to JSON string representtion (only handles Maps, Collections, Arrays, Numbers, and Strings)
Methodenname |
Rückgabetyp |
Verfügbar seit |
toJson |
String |
4.2.14 |
Übersicht
toString
Methodenname |
Rückgabetyp |
Verfügbar seit |
toString |
String |
|
Übersicht
type
Methodenname |
Rückgabetyp |
Verfügbar seit |
type |
String |
|
Übersicht
Druckversion | Seitenanfang