Package de.svws_nrw.data.stundenplan

Klasse DataStundenplanZeitraster

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

  • Konstruktordetails

    • DataStundenplanZeitraster

      public DataStundenplanZeitraster(DBEntityManager conn, Long stundenplanID)
      Erstellt einen neuen DataManager für den Core-DTO StundenplanZeitraster.
      Parameter:
      conn - die Datenbank-Verbindung für den Datenbankzugriff
      stundenplanID - die ID des Stundenplans, dessen Zeitraster abgefragt wird

  • 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

    • getZeitraster

      public static List<StundenplanZeitraster> getZeitraster(@NotNull @NotNull DBEntityManager conn, long idStundenplan) throws ApiOperationException
      Gibt das Zeitraster des Stundenplans zurück.
      Parameter:
      conn - die Datenbankverbindung
      idStundenplan - die ID des Stundenplans
      Gibt zurück:
      das Zeitraster
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getOrCreateZeitrasterEintrag

      public static StundenplanZeitraster getOrCreateZeitrasterEintrag(@NotNull @NotNull DBEntityManager conn, long idStundenplan, int wochentag, int unterrichtsstunde) throws ApiOperationException
      Ermittelt zu dem Tupel (wochentag, unterrichtsstunde) des Stundenplans mit der ID idStundenplan den zugehörigen Zeitrastereintrag in der Datenbank. Existiert ein solcher noch nicht, so wird ein neue Eintrag mit leeren Zeiten erzeugt.
      Parameter:
      conn - die Datenbankverbindung
      idStundenplan - die ID des Stundenplans
      wochentag - der Wochentag
      unterrichtsstunde - die Unterrichtsstunde
      Gibt zurück:
      der Zeitrastereintrag
      Löst aus:
      ApiOperationException - im Fehlerfall

    • 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

    • patchMultiple

      public jakarta.ws.rs.core.Response patchMultiple(InputStream is) throws ApiOperationException
      Führt Patches für mehrere DTOs aus. Die Patches müssen als Liste übergeben werden.
      Parameter:
      is - der Input-Stream mit der Liste der Patches
      Gibt zurück:
      eine NO_CONTENT-Response im Erfolgsfall
      Löst aus:
      ApiOperationException - im Fehlerfall

    • add

      public jakarta.ws.rs.core.Response add(InputStream is) throws ApiOperationException
      Fügt einen Zeitrastereintrag 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

    • addMultiple

      public jakarta.ws.rs.core.Response addMultiple(InputStream is) throws ApiOperationException
      Fügt mehrere Zeitrastereinträge mit den übergebenen JSON-Daten der Datenbank hinzu und gibt die zugehörigen CoreDTOs 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

    • addZeitraster

      public static void addZeitraster(@NotNull @NotNull DBEntityManager conn, DTOStundenplan dtoStundenplan, List<StundenplanZeitraster> eintraege)
      Kopiert die Zeitrastereinträge des allgemeinen Katalogs zu den Zeitrastereinträgen des angegebenen Stundenplans hinzu. Dabei wird die angegebene Datenbankverbingung genutzt, welche eine offene Transaktion haben muss.
      Parameter:
      conn - die Datenbankverbindung
      dtoStundenplan - das DTO des Stundenplans
      eintraege - die hinzuzufügenden Zeitraster-Einträge

    • delete

      public jakarta.ws.rs.core.Response delete(Long id) throws ApiOperationException
      Löscht einen Zeitrastereintrag
      Parameter:
      id - die ID des Zeitrastereintrags
      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 Zeitrastereinträge
      Parameter:
      ids - die IDs der Zeitrastereinträge
      Gibt zurück:
      die HTTP-Response, welchen den Erfolg der Lösch-Operation angibt.
      Löst aus:
      ApiOperationException - im Fehlerfall