Package de.svws_nrw.davapi.data.carddav

Klasse CardDavAdressbuch

java.lang.Object
de.svws_nrw.davapi.data.carddav.CardDavAdressbuch
public final class CardDavAdressbuch extends Object
Die Klasse verwaltet die Zugriffe auf Adressbücher und steuert, wie auf die Daten der zugehörigen Kontakte der Adressbücher zugegriffen wird. Die einzelnen Kontakte werden dabei mit Kategorien versehen, so dass sie in einem geeigneten CardDAV-Client ggf. danach sortierbar und durchsuchbar sind.

  • Konstruktordetails

    • CardDavAdressbuch

      public CardDavAdressbuch(DBEntityManager conn)
      Erstellt eine Instanz zum Zugriff auf die Adressbücher mithilfe der angegebenen Datenbankverbindung
      Parameter:
      conn - die Datenbank-Verbindung

  • Methodendetails

    • getAdressbuchById

      public Adressbuch getAdressbuchById(String idBook, boolean withContacts, boolean withPayload) throws ApiOperationException
      Stellt ein Adressbuch anhand der übergebenen Adressbuch-ID aus der Datenbank zusammen.
      Parameter:
      idBook - die ID des Adressbuches
      withContacts - gibt an, ob die Kontaktdaten im Adressbuch enthalten sein sollen
      withPayload - gibt an, ob die eigentlichen Kontaktdaten bei der Generierung der Kontakte mit erstellt werden
      Gibt zurück:
      das Adressbuch oder null, falls kein Adressbuch mit der übergebenen ID gefunden wurde.
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getAvailableAdressbuecher

      public List<Adressbuch> getAvailableAdressbuecher()
      Gibt die Liste der für den angemeldeten Benutzer verfügbaren Adressbücher zurück.
      Gibt zurück:
      die Liste der Adressbücher