CalendarEntryInformation (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
 
(15 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
<!--{{überarbeiten}}-->
 
 
==Name==
 
==Name==
CalendarEntry - Objekt innerhalb einer [[CalendarInformation]]
+
CalendarEntryInformation - Objekt innerhalb einer [[CalendarInformation]]
  
 
==Beschreibung==
 
==Beschreibung==
CalendarEntry Objekte sind die Objekte, die Kalenderdaten aufnehmen. Sie dienen zur Organisation und Abbildung von Terminen innerhalb des IES.
+
CalendarEntryInformation Objekte sind die Objekte, die Kalenderdaten aufnehmen. Sie dienen zur Organisation und Abbildung von Terminen innerhalb des IES. Alle Attribute, die mit dem Prefix <code>calendar</code> beginnen sind gleichfalls die Typen für die Definition der Eingabefelder innerhalb der entsprechenden Subinformation. Der Name aller Eingabefelder ist stets <code>calendar</code>:
  
'''''Achtung:'''''
+
z.B.
 +
<source lang="xml">
 +
  <sp:subinformation name="ical" type="calendar">
 +
    <sp:text name="calendar" type="calendarType" value="day"/>
 +
    ...
 +
  </sp:subinformation>
  
Aktuell sind für die Suche nach Terminen nur folgende Wiederholungstypen implementiert:
+
  <sp:subinformation name="sp_eventDate" type="calendar">
* day
+
    calendarFrom <sp:text name="calendar" type="calendarFrom" maxlength="10" size="12" format="dd.MM.yyyy"/><br>
* daily
+
    calendarTo <sp:text name="calendar" type="calendarTo" maxlength="10" size="12" format="dd.MM.yyyy"/><br>
* weekly
+
    calendarType <sp:text name="calendar" type="calendarType"/><br>
Alle anderen Kalendertypen lassen sich zwar Speichern, eine Suche über die entsprechenden Daten liefert jedoch kein Ergebnis.
+
    calendarAllDay <sp:text name="calendar" type="calendarAllDay"/><br>
 +
    calendarRepetitionCount <sp:text name="calendar" type="calendarRepetitionCount"/><br>
 +
    calendarRepetitionDate <sp:text name="calendar" type="calendarRepetitionDate" maxlength="10" size="12" format="dd.MM.yyyy"/><br>
 +
    calendarInterval <sp:text name="calendar" type="calendarInterval"/><br>
 +
    calendarDow <sp:text name="calendar" type="calendarDow"/><br>
 +
    calendarDom <sp:text name="calendar" type="calendarDom"/><br>
 +
    calendarDoy <sp:text name="calendar" type="calendarDoy"/><br>
 +
    calendarOom <sp:text name="calendar" type="calendarOom"/><br>
 +
    calendarMoy <sp:text name="calendar" type="calendarMoy"/><br>
 +
  </sp:subinformation>
 +
</source>
 +
 
 +
Weitere Details hierzu bei der Beschreibung des [[sp:subinformation|Subinformation-Tags]].
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
 
|-
 
|-
| calendarFrom
+
| <code>startDay</code>
 +
| [[Number]]
 +
| Der Tag, an dem der Termin beginnt (ohne Uhrzeit) als Long-Wert.
 +
| 2.0.3
 +
|-
 +
| <code>from</code>
 +
| [[Number]]
 +
| Uhrzeit mit dem Start des Termins. Relativ zum Starttag als Long-Wert.
 +
| 2.0.3
 +
|-
 +
| <code>to</code>
 +
| [[Number]]
 +
| Uhrzeit mit dem Ende des Termins. Relativ zum Starttag als Long-Wert. Dieser Wert kann auch über mehrere Tage gehen.
 +
| 2.0.3
 +
|-
 +
| <code>calendarFrom</code>
 
| [[Number]]
 
| [[Number]]
| Startzeitpunkt inkl. Tag und Uhrzeit als Long-Wert
+
| Startzeitpunkt inkl. Tag und Uhrzeit als Long-Wert. Diese Methode erlaubt den einfachen Zugriff auf den Beginn des Termins.
 
| 2
 
| 2
 
|-
 
|-
| calendarTo
+
| <code>calendarTo</code>
 
| [[Number]]
 
| [[Number]]
| Endzeitpunkt inkl. Tag und Uhrzeit als Long-Wert
+
| Endzeitpunkt inkl. Tag und Uhrzeit als Long-Wert. Diese Methode erlaubt den einfachen Zugriff auf den Beginn des Termins.
 
| 2
 
| 2
 
|-
 
|-
| calendarType
+
| <code>calendarType</code>
 
| [[String]]
 
| [[String]]
 
| Typ der Wiederholung des Termins
 
| Typ der Wiederholung des Termins
Zeile 36: Zeile 67:
 
  ! Wert || Beschreibung
 
  ! Wert || Beschreibung
 
  |-
 
  |-
  | day
+
  | <code>day</code>
 
  | fester Termin (z.B. Urlaub)
 
  | fester Termin (z.B. Urlaub)
 
  |-
 
  |-
  | daily
+
  | <code>daily</code>
 
  | tägliche Erinnerung (z.B. Blumen gießen)
 
  | tägliche Erinnerung (z.B. Blumen gießen)
 
  |-
 
  |-
  | weekly
+
  | <code>weekly</code>
 
  | wöchentliche Termine (z.B. alle 4 Wochen Skat)
 
  | wöchentliche Termine (z.B. alle 4 Wochen Skat)
 
  |-
 
  |-
  | monthlyByDay
+
  | <code>monthlyByDay</code>
 
  | der Tag X eines Monats (z.B. Erinnerung an eine Überweisung)
 
  | der Tag X eines Monats (z.B. Erinnerung an eine Überweisung)
 
  |-
 
  |-
  | monthlyByOccurrence
+
  | <code>monthlyByOccurrence</code>
 
  | bestimmter Wochentag zum X-ten mal (z.B. jeden zweiten Samstag im Monat)
 
  | bestimmter Wochentag zum X-ten mal (z.B. jeden zweiten Samstag im Monat)
 
  |-
 
  |-
  | yearlyByDay
+
  | <code>yearlyByDay</code>
 
  | der Tag X eines Jahres (keine sinnvolle Anwendung gefunden)
 
  | der Tag X eines Jahres (keine sinnvolle Anwendung gefunden)
 
  |-
 
  |-
  | yearlyByOccurrence
+
  | <code>yearlyByOccurrence</code>
 
  | bestimmter Wochentag X eines Monats (z.B. FamilienTreffen jedes erste Wochenende im Juni)
 
  | bestimmter Wochentag X eines Monats (z.B. FamilienTreffen jedes erste Wochenende im Juni)
 
  |-
 
  |-
  | yearlyByMonth
+
  | <code>yearlyByMonth</code>
 
  | Tag X eines Monats im Jahr (z.B. Geburtstag)
 
  | Tag X eines Monats im Jahr (z.B. Geburtstag)
 
  |}
 
  |}
 
| 2
 
| 2
 
|-
 
|-
| isRepeat
+
| <code>isRepeat</code>
 
| [[Boolean]]
 
| [[Boolean]]
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| 2
 
| 2
 
|-
 
|-
| isWeekly
+
| <code>isDaily</code>
 
| [[Boolean]]
 
| [[Boolean]]
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| 2
 
| 2
 
|-
 
|-
| isMonthlyByDay
+
| <code>isWeekly</code>
 
| [[Boolean]]
 
| [[Boolean]]
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| 2
 
| 2
 
|-
 
|-
| isMonthlyByOccurrence
+
| <code>isMonthlyByDay</code>
 
| [[Boolean]]
 
| [[Boolean]]
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| 2
 
| 2
 
|-
 
|-
| isYearlyByDay
+
| <code>isMonthlyByOccurrence</code>
 
| [[Boolean]]
 
| [[Boolean]]
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| 2
 
| 2
 
|-
 
|-
| isYearlyByOccurrence
+
| <code>isYearlyByDay</code>
 
| [[Boolean]]
 
| [[Boolean]]
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| 2
 
| 2
 
|-
 
|-
| isYearlyByMonth
+
| <code>isYearlyByOccurrence</code>
 
| [[Boolean]]
 
| [[Boolean]]
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| Hilfsfunktion zur Abfrage des Kalendartyps.
 
| 2
 
| 2
 
|-
 
|-
| calendarInterval
+
| <code>isYearlyByMonth</code>
 +
| [[Boolean]]
 +
| Hilfsfunktion zur Abfrage des Kalendartyps.
 +
| 2
 +
|-
 +
| <code>calendarInterval</code>
 
| [[Number]]
 
| [[Number]]
| Wiederholungen (z.B. jeden 2. Tag)
+
| Intervall der Wiederholungen (z.B. jeden 2. Tag)
 
| 2
 
| 2
 
|-
 
|-
| calendarAllDay
+
| <code>calendarAllDay</code>
 
| [[Boolean]]
 
| [[Boolean]]
 
| Zeigt an, ob es sich um einen ganztägigen Termin handelt.
 
| Zeigt an, ob es sich um einen ganztägigen Termin handelt.
 
| 2
 
| 2
 
|-
 
|-
| calendarRepetitionCount
+
| <code>calendarRepetitionCount</code>
 
| [[Number]]
 
| [[Number]]
| Zeigt die Anzahl der Wiederholungen an.
+
| Zeigt die Anzahl der Wiederholungen an. Wurde lediglich ein Termin zum Ende der Wiederholungen eingeben, so steht dieser Wert nicht zur Verfügung.
 
| 2
 
| 2
 
|-
 
|-
| calendarRepetitionDate
+
| <code>calendarRepetitionDate</code>
 
| [[Number]]
 
| [[Number]]
| Gibt den Zeitpunkt an dem die Wiederholung endet als Long-Wert zurück.
+
| Gibt den Zeitpunkt an dem die Wiederholung endet als Long-Wert zurück. Wurde eine Anzahl an Wiederholungen konfiguriert, so ist dieses Datum automatisch berechnet worden und steht somit zur Verfügung.
 
| 2
 
| 2
 
|-
 
|-
| calendarDow
+
| <code>calendarDow</code>
 
| [[String]]
 
| [[String]]
 
| Gibt die Tage der Woche des Termins als Liste mit folgenden Werten aus
 
| Gibt die Tage der Woche des Termins als Liste mit folgenden Werten aus
Zeile 124: Zeile 160:
 
  ! Wert || Beschreibung
 
  ! Wert || Beschreibung
 
  |-
 
  |-
  | sun
+
  | <code>sun</code>
 
  | Sonntag
 
  | Sonntag
 
  |-
 
  |-
  | mon
+
  | <code>mon</code>
 
  | Montag
 
  | Montag
 
  |-
 
  |-
  | tue
+
  | <code>tue</code>
 
  | Dienstag
 
  | Dienstag
 
  |-
 
  |-
  | wed
+
  | <code>wed</code>
 
  | Mittwoch
 
  | Mittwoch
 
  |-
 
  |-
  | thu
+
  | <code>thu</code>
 
  | Donnerstag
 
  | Donnerstag
 
  |-
 
  |-
  | fri
+
  | <code>fri</code>
 
  | Freitag
 
  | Freitag
 
  |-
 
  |-
  | sat
+
  | <code>sat</code>
 
  | Samstag
 
  | Samstag
 
  |}
 
  |}
 
| 2
 
| 2
 
|-
 
|-
| calendarDom
+
| <code>calendarDom</code>
 
| [[Number]]
 
| [[Number]]
 
| Gibt den Tag des Monats zurück.
 
| Gibt den Tag des Monats zurück.
 
| 2
 
| 2
 
|-
 
|-
| calendarDoy
+
| <code>calendarDoy</code>
 
| [[Number]]
 
| [[Number]]
 
| Gibt den Tag des Jahres zurück.
 
| Gibt den Tag des Jahres zurück.
 
| 2
 
| 2
 
|-
 
|-
| calendarOom
+
| <code>calendarOom</code>
 
| [[Number]]
 
| [[Number]]
 
| Vorkommen innerhalb des Monats.
 
| Vorkommen innerhalb des Monats.
Zeile 163: Zeile 199:
 
| 2
 
| 2
 
|-
 
|-
| calendarMoy
+
| <code>calendarMoy</code>
 
| [[Number]]
 
| [[Number]]
 
| Gibt den Monat des Jahres zurück.
 
| Gibt den Monat des Jahres zurück.
Zeile 170: Zeile 206:
 
  ! Wert || Beschreibung
 
  ! Wert || Beschreibung
 
  |-
 
  |-
  | 0
+
  | <code>0</code>
 
  | Januar
 
  | Januar
 
  |-
 
  |-
  | 1
+
  | <code>1</code>
 
  | Februar
 
  | Februar
 
  |-
 
  |-
  | 2
+
  | <code>2</code>
 
  | März
 
  | März
 
  |-
 
  |-
  | 3
+
  | <code>3</code>
 
  | April
 
  | April
 
  |-
 
  |-
  | 4
+
  | <code>4</code>
 
  | Mai
 
  | Mai
 
  |-
 
  |-
  | 5
+
  | <code>5</code>
 
  | Juni
 
  | Juni
 
  |-
 
  |-
  | 6
+
  | <code>6</code>
 
  | Juli
 
  | Juli
 
  |-
 
  |-
  | 7
+
  | <code>7</code>
 
  | August
 
  | August
 
  |-
 
  |-
  | 8
+
  | <code>8</code>
 
  | September
 
  | September
 
  |-
 
  |-
  | 9
+
  | <code>9</code>
 
  | Oktober
 
  | Oktober
 
  |-
 
  |-
  | 10
+
  | <code>10</code>
 
  | November
 
  | November
 
  |-
 
  |-
  | 11
+
  | <code>11</code>
 
  | Dezember
 
  | Dezember
 
  |}
 
  |}
 
| 2
 
| 2
 +
|-
 +
| <code>range</code>
 +
| [[Number]]
 +
| Anzahl der Tage zwischen Anfang und Ende des Termins
 +
| 2
 +
|-
 +
| <code>allDays</code>
 +
| [[Collection]]
 +
| liefert eine Collection mit allen Tagen zurück, an denen der Termin stattfindet.
 +
| 2
 +
|-
 +
| <code>allStartDays</code>
 +
| [[Collection]]
 +
| liefert eine Collection mit allen Start-Tagen eines Termins zurück. Eine sinnvolle Anwendung findet sich für Wiederholtermine, die über mehrere Tage gehen.
 +
| 2.0.4
 
|}
 
|}
 +
 +
==Methoden==
 +
{| class="prettytable"
 +
|- class="hintergrundfarbe1"
 +
! Methode || Rückgabewert || Beschreibung || ab IES Version
 +
|-
 +
| <code>relativeStartDay([[Number]] date)</code>
 +
| [[Number]]
 +
| Bei Wiederholterminen, die über mehrere Tage gehen, liefert diese Methode den relativen Start-Tag zurück, in das angegebene Datum liegt.
 +
| 2.0.4
 +
|-
 +
| <code>days([[Number]] from, [[Number]] to [,"all"|"start"])</code>
 +
| [[Number]]
 +
| Bei Wiederholterminen, die über mehrere Tage gehen, liefert diese Methode alle (Start-)Tage in dem angegebenen Zeitraum.
 +
| 2.15
 +
|}
 +
 +
;<code>[[Number]] relativeStartDay([[Number]] date)</code>
 +
:
 +
:;Parameter
 +
::;<code>date</code>
 +
:::Datum als <code>Long</code>, für den der entsprechende Start-Tag ermittelt werden soll.
 +
:;Rückgabewert
 +
::;Number
 +
:::Das Datum, an dem der Zeitraum des Termins, bezogen auf die Wiederholungen, beginnt.
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
[[Category:Qualität_der_Sprache_prüfen]]
 
 
[[Category:Qualität_des_Codes_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 13. April 2016, 16:11 Uhr

Name

CalendarEntryInformation - Objekt innerhalb einer CalendarInformation

Beschreibung

CalendarEntryInformation Objekte sind die Objekte, die Kalenderdaten aufnehmen. Sie dienen zur Organisation und Abbildung von Terminen innerhalb des IES. Alle Attribute, die mit dem Prefix calendar beginnen sind gleichfalls die Typen für die Definition der Eingabefelder innerhalb der entsprechenden Subinformation. Der Name aller Eingabefelder ist stets calendar:

z.B.

  <sp:subinformation name="ical" type="calendar">
    <sp:text name="calendar" type="calendarType" value="day"/>
    ...
  </sp:subinformation>

  <sp:subinformation name="sp_eventDate" type="calendar">
    calendarFrom <sp:text name="calendar" type="calendarFrom" maxlength="10" size="12" format="dd.MM.yyyy"/><br>
    calendarTo <sp:text name="calendar" type="calendarTo" maxlength="10" size="12" format="dd.MM.yyyy"/><br>
    calendarType <sp:text name="calendar" type="calendarType"/><br>
    calendarAllDay <sp:text name="calendar" type="calendarAllDay"/><br>
    calendarRepetitionCount <sp:text name="calendar" type="calendarRepetitionCount"/><br>
    calendarRepetitionDate <sp:text name="calendar" type="calendarRepetitionDate" maxlength="10" size="12" format="dd.MM.yyyy"/><br>
    calendarInterval <sp:text name="calendar" type="calendarInterval"/><br>
    calendarDow <sp:text name="calendar" type="calendarDow"/><br>
    calendarDom <sp:text name="calendar" type="calendarDom"/><br>
    calendarDoy <sp:text name="calendar" type="calendarDoy"/><br>
    calendarOom <sp:text name="calendar" type="calendarOom"/><br>
    calendarMoy <sp:text name="calendar" type="calendarMoy"/><br>
  </sp:subinformation>

Weitere Details hierzu bei der Beschreibung des Subinformation-Tags.

Attribute

Attribut Type Beschreibung ab IES Version
startDay Number Der Tag, an dem der Termin beginnt (ohne Uhrzeit) als Long-Wert. 2.0.3
from Number Uhrzeit mit dem Start des Termins. Relativ zum Starttag als Long-Wert. 2.0.3
to Number Uhrzeit mit dem Ende des Termins. Relativ zum Starttag als Long-Wert. Dieser Wert kann auch über mehrere Tage gehen. 2.0.3
calendarFrom Number Startzeitpunkt inkl. Tag und Uhrzeit als Long-Wert. Diese Methode erlaubt den einfachen Zugriff auf den Beginn des Termins. 2
calendarTo Number Endzeitpunkt inkl. Tag und Uhrzeit als Long-Wert. Diese Methode erlaubt den einfachen Zugriff auf den Beginn des Termins. 2
calendarType String Typ der Wiederholung des Termins
Wert Beschreibung
day fester Termin (z.B. Urlaub)
daily tägliche Erinnerung (z.B. Blumen gießen)
weekly wöchentliche Termine (z.B. alle 4 Wochen Skat)
monthlyByDay der Tag X eines Monats (z.B. Erinnerung an eine Überweisung)
monthlyByOccurrence bestimmter Wochentag zum X-ten mal (z.B. jeden zweiten Samstag im Monat)
yearlyByDay der Tag X eines Jahres (keine sinnvolle Anwendung gefunden)
yearlyByOccurrence bestimmter Wochentag X eines Monats (z.B. FamilienTreffen jedes erste Wochenende im Juni)
yearlyByMonth Tag X eines Monats im Jahr (z.B. Geburtstag)
2
isRepeat Boolean Hilfsfunktion zur Abfrage des Kalendartyps. 2
isDaily Boolean Hilfsfunktion zur Abfrage des Kalendartyps. 2
isWeekly Boolean Hilfsfunktion zur Abfrage des Kalendartyps. 2
isMonthlyByDay Boolean Hilfsfunktion zur Abfrage des Kalendartyps. 2
isMonthlyByOccurrence Boolean Hilfsfunktion zur Abfrage des Kalendartyps. 2
isYearlyByDay Boolean Hilfsfunktion zur Abfrage des Kalendartyps. 2
isYearlyByOccurrence Boolean Hilfsfunktion zur Abfrage des Kalendartyps. 2
isYearlyByMonth Boolean Hilfsfunktion zur Abfrage des Kalendartyps. 2
calendarInterval Number Intervall der Wiederholungen (z.B. jeden 2. Tag) 2
calendarAllDay Boolean Zeigt an, ob es sich um einen ganztägigen Termin handelt. 2
calendarRepetitionCount Number Zeigt die Anzahl der Wiederholungen an. Wurde lediglich ein Termin zum Ende der Wiederholungen eingeben, so steht dieser Wert nicht zur Verfügung. 2
calendarRepetitionDate Number Gibt den Zeitpunkt an dem die Wiederholung endet als Long-Wert zurück. Wurde eine Anzahl an Wiederholungen konfiguriert, so ist dieses Datum automatisch berechnet worden und steht somit zur Verfügung. 2
calendarDow String Gibt die Tage der Woche des Termins als Liste mit folgenden Werten aus
Wert Beschreibung
sun Sonntag
mon Montag
tue Dienstag
wed Mittwoch
thu Donnerstag
fri Freitag
sat Samstag
2
calendarDom Number Gibt den Tag des Monats zurück. 2
calendarDoy Number Gibt den Tag des Jahres zurück. 2
calendarOom Number Vorkommen innerhalb des Monats.

z.B. 30.7.2007 (Montag) = 5. Montag eines Monats.

2
calendarMoy Number Gibt den Monat des Jahres zurück.
Wert Beschreibung
0 Januar
1 Februar
2 März
3 April
4 Mai
5 Juni
6 Juli
7 August
8 September
9 Oktober
10 November
11 Dezember
2
range Number Anzahl der Tage zwischen Anfang und Ende des Termins 2
allDays Collection liefert eine Collection mit allen Tagen zurück, an denen der Termin stattfindet. 2
allStartDays Collection liefert eine Collection mit allen Start-Tagen eines Termins zurück. Eine sinnvolle Anwendung findet sich für Wiederholtermine, die über mehrere Tage gehen. 2.0.4

Methoden

Methode Rückgabewert Beschreibung ab IES Version
relativeStartDay(Number date) Number Bei Wiederholterminen, die über mehrere Tage gehen, liefert diese Methode den relativen Start-Tag zurück, in das angegebene Datum liegt. 2.0.4
days(Number from, Number to [,"all"|"start"]) Number Bei Wiederholterminen, die über mehrere Tage gehen, liefert diese Methode alle (Start-)Tage in dem angegebenen Zeitraum. 2.15
Number relativeStartDay(Number date)
Parameter
date
Datum als Long, für den der entsprechende Start-Tag ermittelt werden soll.
Rückgabewert
Number
Das Datum, an dem der Zeitraum des Termins, bezogen auf die Wiederholungen, beginnt.