Package de.svws_nrw.data.schule

Klasse DataSchulen

java.lang.Object
de.svws_nrw.data.DataManager<Long>
de.svws_nrw.data.schule.DataSchulen
public final class DataSchulen extends DataManager<Long>
Diese Klasse erweitert den abstrakten DataManager für den Core-DTO SchulEintrag.

  • Konstruktordetails

    • DataSchulen

      public DataSchulen(DBEntityManager conn)
      Erstellt einen neuen DataManager für den Core-DTO SchulEintrag.
      Parameter:
      conn - die Datenbank-Verbindung für den Datenbankzugriff

  • Methodendetails

    • getAll

      public jakarta.ws.rs.core.Response getAll() throws ApiOperationException
      Beschreibung aus Klasse kopiert: DataManager
      Ermittelt eine Liste mit allen Informationen in der DB. Wird üblicherweise durch GET-Methoden für Listen verwendet. Meist ist die Methode getList zu bevorzugen.
      Angegeben von:
      getAll in Klasse DataManager<Long>
      Gibt zurück:
      eine Liste mit den Informationen
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getSchulen

      public static List<SchulEintrag> getSchulen(@NotNull @NotNull DBEntityManager conn)
      Gibt die Einträge im Katalog der Schulen zurück.
      Parameter:
      conn - die Datenbankverbindung
      Gibt zurück:
      die Liste der Schulen

    • getSchulenMitKuerzel

      public static List<SchulEintrag> getSchulenMitKuerzel(@NotNull @NotNull DBEntityManager conn)
      Gibt die Einträge im Katalog der Schulen zurück, welche ein Kürzel gesetzt haben.
      Parameter:
      conn - die Datenbankverbindung
      Gibt zurück:
      die Liste der Schulen, welche ein Kürzel gesetzt haben

    • getList

      public jakarta.ws.rs.core.Response getList() throws ApiOperationException
      Beschreibung aus Klasse kopiert: DataManager
      Ermittelt eine Liste mit Informationen. Wird üblicherweise durch GET-Methoden für Listen verwendet. Bei dieser Liste werden ggf. Filter verwendet (z.B. nur als sichtbar markierte Einträge)
      Angegeben von:
      getList in Klasse DataManager<Long>
      Gibt zurück:
      eine Liste mit den Informationen
      Löst aus:
      ApiOperationException - im Fehlerfall

    • get

      public jakarta.ws.rs.core.Response get(Long id) throws ApiOperationException
      Beschreibung aus Klasse kopiert: DataManager
      Ermittelt die Informationen anhand der angegebenen ID. Wird üblicherweise durch GET-Methoden verwendet.
      Angegeben von:
      get in Klasse DataManager<Long>
      Parameter:
      id - die ID der gesuchten Informationen
      Gibt zurück:
      die Information mit der angebenen ID
      Löst aus:
      ApiOperationException - im Fehlerfall

    • patch

      public jakarta.ws.rs.core.Response patch(Long id, InputStream is) throws ApiOperationException
      Beschreibung aus Klasse kopiert: DataManager
      Passt die Informationen mithilfe des JSON-Patches aus dem übergebenen InputStream an.
      Angegeben von:
      patch in Klasse DataManager<Long>
      Parameter:
      id - die ID der anzupassenden Informationen
      is - der InputStream mit dem JSON-Patch
      Gibt zurück:
      Die HTTP-Response der Patch-Operation
      Löst aus:
      ApiOperationException - im Fehlerfall

    • add

      public jakarta.ws.rs.core.Response add(InputStream is) throws ApiOperationException
      Fügt ein Schul-Katalog-Eintrag mit den übergebenen JSON-Daten der Datenbank hinzu und gibt das zugehörige CoreDTO zurück. Falls ein Fehler auftritt wird ein entsprechender Response-Code zurückgegeben.
      Parameter:
      is - der InputStream mit den JSON-Daten
      Gibt zurück:
      die Response mit den Daten
      Löst aus:
      ApiOperationException - im Fehlerfall

    • delete

      public jakarta.ws.rs.core.Response delete(Long id) throws ApiOperationException
      Löscht einen Schul-Katalog-Eintrag
      Parameter:
      id - die ID des Schul-Katalog-Eintrag
      Gibt zurück:
      die HTTP-Response, welchen den Erfolg der Lösch-Operation angibt.
      Löst aus:
      ApiOperationException - im Fehlerfall

    • deleteMultiple

      public jakarta.ws.rs.core.Response deleteMultiple(List<Long> ids) throws ApiOperationException
      Löscht mehrere Schul-Katalog-Einträge
      Parameter:
      ids - die IDs der Einträge
      Gibt zurück:
      die HTTP-Response, welchen den Erfolg der Lösch-Operation angibt.
      Löst aus:
      ApiOperationException - im Fehlerfall