Information (Objekt): Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
(7 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
Zeile 3: | Zeile 3: | ||
==Beschreibung== | ==Beschreibung== | ||
− | Eine Information ist ein Objekt, das Content innerhalb eines [[Element|Elementes]] enthält. Jedes Element hat einen Satz von Attributen, die die Stammdaten des | + | Eine Information ist ein Objekt, das Content innerhalb eines [[Element|Elementes]] enthält. Jedes Element hat einen Satz von Attributen, die die Stammdaten des Elementes bilden. Darüber hinaus kann jedes Element beliebige weitere Attribute erhalten. Erzeugt und geändert werden können diese generischen Attribute mit Hilfe der SP- und SPT-Input-Tags ([[sp:text]], [[sp:textarea]], [[spt:text]], etc.). Je nachdem mit welchem Typ das Attribut definiert wurde, wird ein entsprechendes Informations-Objekt erzeugt. |
− | Konkrete | + | Konkrete Informations-Objekte sind: |
* [[BinaryInformation]] | * [[BinaryInformation]] | ||
+ | * [[CalendarInformation]] | ||
* [[CounterInformation]] | * [[CounterInformation]] | ||
* [[EmailInformation]] | * [[EmailInformation]] | ||
Zeile 21: | Zeile 22: | ||
* [[SubInformation]] | * [[SubInformation]] | ||
* [[TaskInformation]] | * [[TaskInformation]] | ||
+ | * [[PrimitiveInformation]] | ||
==Attribute== | ==Attribute== | ||
Zeile 33: | Zeile 35: | ||
|- | |- | ||
| field | | field | ||
− | | [[ | + | | [[String]] |
| Variablenname des Objektes | | Variablenname des Objektes | ||
| 1 | | 1 | ||
+ | |- | ||
+ | | lastField | ||
+ | | [[String]] | ||
+ | | Variablenname des Objektes ohne Struktur-Date | ||
+ | | 2.13 | ||
|- | |- | ||
| root | | root | ||
Zeile 59: | Zeile 66: | ||
| flat | | flat | ||
| [[Collection]] <[[Information]]> | | [[Collection]] <[[Information]]> | ||
− | | Liefert eine Liste aller Unter-Informationen ohne | + | | Liefert eine Liste aller Unter-Informationen ohne Strukturierungs-Objekte wie [[ListInformation|ListInformations]], [[ListItemInformation|ListItemInformations]] oder [[SubInformation|SubInformations]]. |
| 1 | | 1 | ||
|} | |} | ||
+ | ==Methoden== | ||
+ | {| class="prettytable sortable" | ||
+ | |- class="hintergrundfarbe1" | ||
+ | ! Methode || Rückgabewert || Beschreibung || ab IES Version | ||
+ | |- | ||
+ | | <code>locale([[String]] locale)</code> | ||
+ | | Object | ||
+ | | Liefert bei einem Mehrsprachigem Feld den Text mit der angegebenen Sprache | ||
+ | | 2.13 | ||
+ | |- | ||
+ | | <code>locale([[String]] locale, [[Boolean]] lookup)</code> | ||
+ | | Object | ||
+ | | Liefert bei einem Mehrsprachigem Feld den Text mit der angegebenen Sprache | ||
+ | | 2.13 | ||
+ | |- | ||
+ | | <code>toXip([[Boolean]] emptyFields)</code> | ||
+ | | String | ||
+ | | Erzeugt XML-Daten im XIP-Format für dieses Objekt | ||
+ | | 2.14 | ||
+ | |} | ||
+ | |||
+ | ;<code>[[Object]] locale([[String]] locale, [[Boolean]] lookup)</code> | ||
+ | :Liefert bei einem Mehrsprachigem Feld den Text mit der angegebenen Sprache. Es wird ein Lookup angewendet (wenn nicht deaktiviert). der zunächst nach z.B. de_DE sucht, wenn für das Locale ein Text definiert ist, dann wird nach de gesucht, wenn dann auch noch nichts gefunden wird, dann wir nach default gesucht. Wenn es sich nicht um eine Mehrsprachige Information handelt wird dieses Objekt zurück gegeben. | ||
+ | :;Parameter | ||
+ | ::;<code>String locale</code> | ||
+ | :::Locale das verwendet werden soll. | ||
+ | ::;<code>Boolean lookup</code> (optional, default ist true) | ||
+ | :::Gibt an ob ein Lookup für das Locale angewendet werden soll. | ||
+ | :;Rückgabewert | ||
+ | ::;Object | ||
+ | :::Text der angegebenen Sprache oder dieses Object, wenn Mehrsprachigkeit für dieses Object nicht unterstützt wird. | ||
+ | ;<code>[[String]] toXip([[Boolean]] emptyFields)</code> | ||
+ | :Erzeugt XML-Daten im XIP-Format für dieses Objekt. | ||
+ | :;Parameter | ||
+ | ::;<code>Boolean emptyFields</code> | ||
+ | :::Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true). | ||
+ | :;Rückgabewert | ||
+ | ::;String | ||
+ | :::XML-Daten im XIP-Format | ||
<noinclude> | <noinclude> | ||
[[Category:Objekte]] | [[Category:Objekte]] | ||
− | |||
[[Category:Qualität_des_Codes_prüfen]] | [[Category:Qualität_des_Codes_prüfen]] | ||
</noinclude> | </noinclude> |
Aktuelle Version vom 10. Mai 2016, 06:28 Uhr
Name
Information - Content-Objekt innerhalb eines Elementes
Beschreibung
Eine Information ist ein Objekt, das Content innerhalb eines Elementes enthält. Jedes Element hat einen Satz von Attributen, die die Stammdaten des Elementes bilden. Darüber hinaus kann jedes Element beliebige weitere Attribute erhalten. Erzeugt und geändert werden können diese generischen Attribute mit Hilfe der SP- und SPT-Input-Tags (sp:text, sp:textarea, spt:text, etc.). Je nachdem mit welchem Typ das Attribut definiert wurde, wird ein entsprechendes Informations-Objekt erzeugt.
Konkrete Informations-Objekte sind:
- BinaryInformation
- CalendarInformation
- CounterInformation
- EmailInformation
- ExcelWorkbookInformation
- ImageInformation
- LdapRequestInformation
- LinkTreeInformation
- ListInformation
- ListItemInformation
- PersonalizationInformation
- QueryInformation
- RRequestInformation
- SimpleInformation
- SubInformation
- TaskInformation
- PrimitiveInformation
Attribute
Attribut | Type | Beschreibung | ab IES Version |
---|---|---|---|
id | ID | ID des Objektes | 1 |
field | String | Variablenname des Objektes | 1 |
lastField | String | Variablenname des Objektes ohne Struktur-Date | 2.13 |
root | Element | Root-Element dieser Information | 1 |
parent | ID | ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein | 1 |
isEmpty | Boolean | true , wenn das Objekt leer ist.
|
1 |
all | Collection <Information> | Liefert eine Liste alle Unter-Informationen | 1 |
flat | Collection <Information> | Liefert eine Liste aller Unter-Informationen ohne Strukturierungs-Objekte wie ListInformations, ListItemInformations oder SubInformations. | 1 |
Methoden
Methode | Rückgabewert | Beschreibung | ab IES Version |
---|---|---|---|
locale(String locale)
|
Object | Liefert bei einem Mehrsprachigem Feld den Text mit der angegebenen Sprache | 2.13 |
locale(String locale, Boolean lookup)
|
Object | Liefert bei einem Mehrsprachigem Feld den Text mit der angegebenen Sprache | 2.13 |
toXip(Boolean emptyFields)
|
String | Erzeugt XML-Daten im XIP-Format für dieses Objekt | 2.14 |
Object locale(String locale, Boolean lookup)
- Liefert bei einem Mehrsprachigem Feld den Text mit der angegebenen Sprache. Es wird ein Lookup angewendet (wenn nicht deaktiviert). der zunächst nach z.B. de_DE sucht, wenn für das Locale ein Text definiert ist, dann wird nach de gesucht, wenn dann auch noch nichts gefunden wird, dann wir nach default gesucht. Wenn es sich nicht um eine Mehrsprachige Information handelt wird dieses Objekt zurück gegeben.
- Parameter
-
String locale
- Locale das verwendet werden soll.
Boolean lookup
(optional, default ist true)- Gibt an ob ein Lookup für das Locale angewendet werden soll.
- Rückgabewert
-
- Object
- Text der angegebenen Sprache oder dieses Object, wenn Mehrsprachigkeit für dieses Object nicht unterstützt wird.