Package de.svws_nrw.davapi.data.carddav

Klasse DataManagerCardDav

java.lang.Object
de.svws_nrw.davapi.data.carddav.DataManagerCardDav
Bekannte direkte Unterklassen:
DataCardDavErzieher, DataCardDavLehrer, DataCardDavSchueler
public abstract class DataManagerCardDav extends Object
Eine abstrakte Basisklasse für den Zugriff auf Daten für ein Adressbuch.

  • Felddetails

    • conn

      protected final DBEntityManager conn
      Die Datenbank-Verbindung

    • schuljahresabschnitt

      protected final Schuljahresabschnitt schuljahresabschnitt
      Die ID des Schuljahresabschnittes bei generierten Adressbüchern für welchen die Daten ermittelt werden sollen

    • strSchuljahresabschnitt

      protected final String strSchuljahresabschnitt
      Die String-Darstellung für den Schuljahresabschnitt, welche auch in den Kategorien genutzt wird.

  • Konstruktordetails

    • DataManagerCardDav

      protected DataManagerCardDav(DBEntityManager conn, long idSchuljahresabschnitt) throws ApiOperationException
      Erstellt einen neuen Daten-Manager für den Zugriff auf ein Adressbuch
      Parameter:
      conn - die Verbindung für den Datenbank-Zugriff
      idSchuljahresabschnitt - die ID des Schuljahresabschnittes, auf welchen sich die Anfrage bezieht
      Löst aus:
      ApiOperationException

  • Methodendetails

    • mapEmptyContact

      public AdressbuchEintrag mapEmptyContact(long id)
      Erstellt einen Kontakt ohne Payload, d.h. nur mit der Kontakt-ID der zugrundliegenden Daten.
      Parameter:
      id - die ID der zugrundliegenden Daten (z.B. Schüler-ID)
      Gibt zurück:
      der Adressbuch-Eintrag ohne Payload

    • getKontaktId

      public abstract String getKontaktId(long id)
      Gibt die ID für den Kontakt auf Grundlage der übergebenen ID zurück.
      Parameter:
      id - die ID der zugrundeliegenden Daten (z.B. Schüler-ID 375)
      Gibt zurück:
      die ID für den Kontakt, z.B. "Schueler_2024_1_375"

    • getKontakte

      public abstract List<AdressbuchEintrag> getKontakte(String idBook, boolean withPayload) throws ApiOperationException
      Gibt die Liste der Kontakte aus dem Adressbuch mit der übergebenen ID zurück.
      Parameter:
      idBook - die ID des Adressbuchs
      withPayload - gibt an, ob die eigentlichen Kontaktdaten bei der Generierung der Kontakte mit erstellt werden
      Gibt zurück:
      die Liste mit Kontakten des angegebenen Adressbuchs.
      Löst aus:
      ApiOperationException - im Fehlerfall

    • queryMapOrte

      protected Map<Long,DTOOrt> queryMapOrte(Set<Long> ortIds)
      Erstellt für die übergebenen IDs von Orten eine Map auf deren DTOs.
      Parameter:
      ortIds - die IDs der Orte
      Gibt zurück:
      die Map

    • addStandardTelefonnummer

      protected void addStandardTelefonnummer(String telefonnummer, List<Telefonnummer> telefonnummern, String type)
      Eine Hilfsmethode, die prüft, ob eine Liste mit Telefonnummern eine gegebene Nummer bereits enthält. Ist dies nicht der Fall, so wird diese Nummer der Liste der Telefonnummern hinzugefügt.
      Parameter:
      telefonnummer - die Telefonnummer für das Hinzufügen
      telefonnummern - eine vorhandene Liste mit Telefonnummern
      type - der Typ der Telefonnummer, z.B. cell or voice

    • getSchulname

      protected String getSchulname()
      Gibt den Namen der Schule zurück.
      Gibt zurück:
      der Name der Schule