Package de.svws_nrw.davapi.data.caldav

Klasse CalDavKalender

java.lang.Object
de.svws_nrw.davapi.data.caldav.CalDavKalender
public final class CalDavKalender extends Object
das DB-Repository für Kalender und Kalendereinträge. Greift auf ein DavDBRepository zurück.

  • Konstruktordetails

  • Methodendetails

    • getKalenderById

      public Kalender getKalenderById(String idCal, boolean withEintraege, boolean withPayload)
      Stellt einen Kalender anhand der übergebenen Kalender-ID aus der Datenbank zusammen.
      Parameter:
      idCal - die ID des Kalenders
      withEintraege - gibt an, ob die Einträge im Kalender enthalten sein sollen
      withPayload - gibt an, ob die eigentlichen Daten bei der Generierung der Einträge mit erstellt werden
      Gibt zurück:
      der Kalender oder null, falls kein Kalender mit der übergebenen ID gefunden wurde.

    • getAvailableKalender

      public List<Kalender> getAvailableKalender()
      Gibt die Liste der für den angemeldeten Benutzer verfügbaren Kalender zurück.
      Gibt zurück:
      die Liste der Kalender

    • getAvailableKalender

      @NotNull public @NotNull List<Kalender> getAvailableKalender(boolean withEintraege, boolean withPayload) throws DavException
      Ermittelt eine Liste aller für den angemeldeten Benutzer verfügbaren Kalender.
      Parameter:
      withEintraege - gibt an, ob die Einträge mit bestimmt werden sollen oder nicht
      withPayload - gibt an, ob bei Einträgen auch der tatsächliche Inhalt zurückgegeben werden soll
      Gibt zurück:
      die Liste der Kalender.
      Löst aus:
      DavException - wenn beim Bestimmen der Kalender ein Fehler auftritt

    • persistEintrag

      public String persistEintrag(KalenderEintrag eintrag)
      Speichert einen Kalender-Eintrag in der Datenbank. Existiert bereits ein Eintrag mit den zugehörigen IDs von Kalender und Eintrag, so wird dieser aktualisiert. Ansonsten wird ein neuer Eintrag angelegt.
      Parameter:
      eintrag - der Kalendereintrag
      Gibt zurück:
      die neue Version des gespeicherten Kalendereintrags (Entity-Tag) oder null im Fehlerfall

    • getDeletedEintragUIDs

      public List<String> getDeletedEintragUIDs(@NotNull @NotNull String idCal, long syncToken) throws DavException
      Gibt die UIDs von gelöschten Einträgen eines Kalenders seit dem gegegebenen Zeitpunkt zurück.
      Parameter:
      idCal - die ID des Kalenders
      syncToken - der Zeitpunkt als Millisekunden seit 1970, Timestamp.getTime()
      Gibt zurück:
      eine Liste der Ressourcen-UIDs, welche seit dem gesuchten Zeitpunkt als gelöscht markiert wurden
      Löst aus:
      DavException - im Fehlerfall

    • deleteKalenderEintrag

      public boolean deleteKalenderEintrag(@NotNull @NotNull String idCal, String uid, Long syncToken) throws DavException
      Entfernt einen Kalendereintrag anhand der UID aus dem Kalender mit der übergebenen ID, sofern der übergebene SyncToken mit dem gespeicherten übereinstimmt, d.h. die Anfrage auf dem aktuellen Kalendereintrag basiert.
      Parameter:
      idCal - die ID des Kalenders
      uid - die UID des Kalendereintrags
      syncToken - der SyncToken aus der Anfrage für den Abgleich der letzten Änderung an der Ressource
      Gibt zurück:
      true, wenn das Löschen erfolgreich war, und ansonsten false
      Löst aus:
      DavException - im Fehlerfall (z.B. fehlende Rechte auf dem Kalender, fehlender Kalendereintrag, abweichendes Synctoken, ...)