Startseite
Startseite

Startseite / Vorlagenentwicklung / Vorlagensyntax / Datentypen / TargetReference

Datentyp TargetReferenceVerfügbar ab FirstSpirit-Version 4.2

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
Methodenname Rückgabetyp Kurzbeschreibung Verfügbar seit
compareTo(Comparable) int
equals(Object) boolean
get IDProvider
getClass Class Klasse des aufrufenden Objektes
getContent Content2
getDocumentGroup DocumentGroup
getLanguage Language
getMedia Media
getPage Page
getPageRef PageRef
getRemoteSymName String
getSection Section
getSectionName String
getStoreType Store$Type
getUid String
getUidType IDProvider$UidType
isCase(Object) boolean
isEmpty boolean Prüft, ob ein Ausdruck leer ist
isNull boolean Prüft, ob ein Ausdruck Null ist
loadSection(Page, String) Section
print void
resetTo(IDProvider, String) void
set(IDProvider) void
set(String, Object) Object
setRemoteSymName(String) void
setSection(Section) void
setSectionName(String) void
setUid(String) void
setUidType(IDProvider$UidType) void
toJson String Convert to JSON string representtion (only handles Maps, Collections, Arrays, Numbers, and Strings) 4.2.14
toString String
type String

compareTo(Comparable)

Methodenname Rückgabetyp Verfügbar seit
compareTo(Comparable) int

equals(Object)

Methodenname Rückgabetyp Verfügbar seit
equals(Object) boolean

get

Methodenname Rückgabetyp Verfügbar seit
get IDProvider

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

getContent

Methodenname Rückgabetyp Verfügbar seit
getContent Content2

getDocumentGroup

Methodenname Rückgabetyp Verfügbar seit
getDocumentGroup DocumentGroup

getLanguage

Methodenname Rückgabetyp Verfügbar seit
getLanguage Language

getMedia

Methodenname Rückgabetyp Verfügbar seit
getMedia Media

getPage

Methodenname Rückgabetyp Verfügbar seit
getPage Page

getPageRef

Methodenname Rückgabetyp Verfügbar seit
getPageRef PageRef

getRemoteSymName

Methodenname Rückgabetyp Verfügbar seit
getRemoteSymName String

getSection

Methodenname Rückgabetyp Verfügbar seit
getSection Section

getSectionName

Methodenname Rückgabetyp Verfügbar seit
getSectionName String

getStoreType

Methodenname Rückgabetyp Verfügbar seit
getStoreType Store$Type

getUid

Methodenname Rückgabetyp Verfügbar seit
getUid String

getUidType

Methodenname Rückgabetyp Verfügbar seit
getUidType IDProvider$UidType

isCase(Object)

Methodenname Rückgabetyp Verfügbar seit
isCase(Object) boolean

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

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

loadSection(Page, String)

Methodenname Rückgabetyp Verfügbar seit
loadSection(Page, String) Section

print

Methodenname Rückgabetyp Verfügbar seit
print void

resetTo(IDProvider, String)

Methodenname Rückgabetyp Verfügbar seit
resetTo(IDProvider, String) void

set(IDProvider)

Methodenname Rückgabetyp Verfügbar seit
set(IDProvider) void

set(String, Object)

Methodenname Rückgabetyp Verfügbar seit
set(String, Object) Object

setRemoteSymName(String)

Methodenname Rückgabetyp Verfügbar seit
setRemoteSymName(String) void

setSection(Section)

Methodenname Rückgabetyp Verfügbar seit
setSection(Section) void

setSectionName(String)

Methodenname Rückgabetyp Verfügbar seit
setSectionName(String) void

setUid(String)

Methodenname Rückgabetyp Verfügbar seit
setUid(String) void

setUidType(IDProvider$UidType)

Methodenname Rückgabetyp Verfügbar seit
setUidType(IDProvider$UidType) void

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

toString

Methodenname Rückgabetyp Verfügbar seit
toString String

type

Methodenname Rückgabetyp Verfügbar seit
type String

© 2005 - 2015 e-Spirit AG | Alle Rechte vorbehalten. | Letzte Änderung: 2014-02-11