CalendarInformation (Objekt): Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Sed (Diskussion | Beiträge) |
|||
(13 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt) | |||
Zeile 3: | Zeile 3: | ||
==Beschreibung== | ==Beschreibung== | ||
− | Eine CalendarInformation beschreibt einen | + | Eine <code>CalendarInformation</code> beschreibt einen Kalendereintrag durch eine Liste von [[CalendarEntryInformation (Objekt)|CalendarEntryInformation-Objekten]] und einer Liste von [[TaskInformation (Objekt)|TaskInformation-Objekten]]. |
==Attribute== | ==Attribute== | ||
− | {| class="prettytable" | + | {| class="prettytable sortable" |
|- class="hintergrundfarbe1" | |- class="hintergrundfarbe1" | ||
! Attribut || Type || Beschreibung || ab IES Version | ! Attribut || Type || Beschreibung || ab IES Version | ||
|- | |- | ||
− | | id | + | | <code>id</code> |
| [[ID]] | | [[ID]] | ||
| ID des Objektes | | ID des Objektes | ||
− | | | + | | 2 |
|- | |- | ||
− | | field | + | | <code>field</code> |
− | | [[ | + | | [[String]] |
| Variablenname des Objektes | | Variablenname des Objektes | ||
− | | | + | | 2 |
+ | |- | ||
+ | | lastField | ||
+ | | [[String]] | ||
+ | | Variablenname des Objektes ohne Struktur-Date | ||
+ | | 2.13 | ||
|- | |- | ||
− | | root | + | | <code>root</code> |
| [[Element]] | | [[Element]] | ||
| Root-Element dieser Information | | Root-Element dieser Information | ||
+ | | 2 | ||
+ | |- | ||
+ | | parent | ||
+ | | [[ID]] | ||
+ | | ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein | ||
| 1 | | 1 | ||
|- | |- | ||
− | | locale | + | | <code>locale</code> |
| [[Locale]] | | [[Locale]] | ||
| Sprache, für die die Information gilt | | Sprache, für die die Information gilt | ||
− | | | + | | 2 |
|- | |- | ||
− | | isEmpty | + | | <code>isEmpty</code> |
| [[Boolean]] | | [[Boolean]] | ||
| <code>true</code>, wenn das Objekt leer ist | | <code>true</code>, wenn das Objekt leer ist | ||
− | |||
− | |||
− | |||
− | |||
− | |||
| 2 | | 2 | ||
|- | |- | ||
− | | | + | | <code>tasks</code> |
| [[Collection]] <[[TaskInformation]]> | | [[Collection]] <[[TaskInformation]]> | ||
− | | | + | | Die Liste von TaskInformation-Objekten |
| 2 | | 2 | ||
|- | |- | ||
− | | | + | | <code>calendar</code> |
− | + | | [[Collection]] <[[CalendarEntryInformation]]> | |
− | | | + | | Die Liste von CalendarEntryInformation-Objekten |
− | | 2 | + | | 2.0.3 |
+ | |} | ||
+ | |||
+ | ==Methoden== | ||
+ | {| class="prettytable" | ||
+ | |- class="hintergrundfarbe1" | ||
+ | ! Methode || Rückgabewert || Beschreibung || ab IES Version | ||
|- | |- | ||
− | | | + | | <code>dates([[Boolean]] startDays)</code> |
− | + | | [[Collection]] | |
− | | | + | | Alle Termine bzw. Tage eines Termins als Liste von [[Long]]-Objekten ausgeben |
− | | 2 | + | | 2.10.5 |
|- | |- | ||
− | | | + | | <code>dates()</code> |
− | | [[ | + | | [[Collection]] |
− | + | | Alle Termine bzw. Tage eines Termins als Liste von [[Long]]-Objekten ausgeben | |
− | | 2 | + | | 2.10.5 |
|- | |- | ||
− | | | + | | <code>toXip([[Boolean]] emptyFields)</code> |
− | + | | String | |
− | + | | Erzeugt XML-Daten im XIP-Format für dieses Objekt | |
− | + | | 2.14 | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | | | ||
− | |||
− | |- | ||
− | |||
− | |||
− | |||
− | | 2 | ||
|} | |} | ||
+ | ;<code>[[Collection]] dates([[Boolean]] startDays)</code> | ||
+ | : | ||
+ | :;Parameter | ||
+ | ::;<code>startDays</code> | ||
+ | :::true: Bei mehrtägigen Terminen nur den Start-Tag berücksichtigen, false: Alle Tage ausgeben | ||
+ | :;Rückgabewert | ||
+ | ::;Collection | ||
+ | :::Alle Termine bzw. Tage eines Termins als Liste von [[Long]]-Objekten | ||
+ | |||
+ | ;<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_Inhalts_prüfen]] | [[Category:Qualität_des_Inhalts_prüfen]] | ||
− | |||
[[Category:Qualität_des_Codes_prüfen]] | [[Category:Qualität_des_Codes_prüfen]] | ||
</noinclude> | </noinclude> |
Aktuelle Version vom 4. November 2015, 13:10 Uhr
Name
CalendarInformation - Kalendareintrag für ein Element
Beschreibung
Eine CalendarInformation
beschreibt einen Kalendereintrag durch eine Liste von CalendarEntryInformation-Objekten und einer Liste von TaskInformation-Objekten.
Attribute
Attribut | Type | Beschreibung | ab IES Version |
---|---|---|---|
id
|
ID | ID des Objektes | 2 |
field
|
String | Variablenname des Objektes | 2 |
lastField | String | Variablenname des Objektes ohne Struktur-Date | 2.13 |
root
|
Element | Root-Element dieser Information | 2 |
parent | ID | ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein | 1 |
locale
|
Locale | Sprache, für die die Information gilt | 2 |
isEmpty
|
Boolean | true , wenn das Objekt leer ist
|
2 |
tasks
|
Collection <TaskInformation> | Die Liste von TaskInformation-Objekten | 2 |
calendar
|
Collection <CalendarEntryInformation> | Die Liste von CalendarEntryInformation-Objekten | 2.0.3 |
Methoden
Methode | Rückgabewert | Beschreibung | ab IES Version |
---|---|---|---|
dates(Boolean startDays)
|
Collection | Alle Termine bzw. Tage eines Termins als Liste von Long-Objekten ausgeben | 2.10.5 |
dates()
|
Collection | Alle Termine bzw. Tage eines Termins als Liste von Long-Objekten ausgeben | 2.10.5 |
toXip(Boolean emptyFields)
|
String | Erzeugt XML-Daten im XIP-Format für dieses Objekt | 2.14 |
Collection dates(Boolean startDays)
-
- Parameter
-
startDays
- true: Bei mehrtägigen Terminen nur den Start-Tag berücksichtigen, false: Alle Tage ausgeben
- Rückgabewert
-
- Collection
- Alle Termine bzw. Tage eines Termins als Liste von Long-Objekten