Package de.svws_nrw.data.schule

Klasse DataSchuleStammdaten

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

  • Konstruktordetails

    • DataSchuleStammdaten

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

  • Methodendetails

    • getAll

      public jakarta.ws.rs.core.Response getAll()
      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

    • getList

      public jakarta.ws.rs.core.Response getList()
      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

    • getStammdaten

      public static SchuleStammdaten getStammdaten(DBEntityManager conn) throws ApiOperationException
      Ermittelt die Schulstammdaten zu der angegebenen ID aus der DB.
      Parameter:
      conn - die Datenbank-Verbindung
      Gibt zurück:
      die Stammdaten
      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

    • getSchulnummer

      public Integer getSchulnummer()
      Bestimmt die Schulnummer der Schule
      Gibt zurück:
      die Schulnummer oder null im Fehlerfall

    • getSchulnummerResponse

      public jakarta.ws.rs.core.Response getSchulnummerResponse() throws ApiOperationException
      Bestimmt die Schulnummer der Schule
      Gibt zurück:
      Die HTTP-Response (NOT_FOUND im Fehlerfall)
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getAnzahlAbschnitte

      public static int getAnzahlAbschnitte(DBEntityManager conn)
      Gibt die Anzahl der Abschnitte pro Schuljahr
      Parameter:
      conn - die Datenbankverbindung, welche bei der Abfrage genutzt wird
      Gibt zurück:
      die Anzahl der Abschnitte pro Schuljahr

    • 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

    • getSchullogo

      public jakarta.ws.rs.core.Response getSchullogo() throws ApiOperationException
      Ermittelt das Schullogo.
      Gibt zurück:
      Die HTTP-Response der Get-Operation
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getSchullogoBase64

      public String getSchullogoBase64()
      Ermittelt das Schullogo im Base64-Format.
      Gibt zurück:
      Schullogo im Base64-Format

    • putSchullogo

      public jakarta.ws.rs.core.Response putSchullogo(InputStream is) throws ApiOperationException
      Ersetzt das Schullogo.
      Parameter:
      is - der InputStream mit dem JSON-Patch für das Logo
      Gibt zurück:
      Die HTTP-Response der Patch-Operation
      Löst aus:
      ApiOperationException - im Fehlerfall

    • init

      public jakarta.ws.rs.core.Response init(int schulnummer) throws ApiOperationException
      Initialisiert das Schema mit der angebenen Schulnummer
      Parameter:
      schulnummer - die Schulnummer der anzulegenden Schule
      Gibt zurück:
      die HTTP-Response mit den Stammdaten der Schule
      Löst aus:
      ApiOperationException - im Fehlerfall