Package de.svws_nrw.data.klassen

Klasse DataKlassendaten

java.lang.Object
de.svws_nrw.data.DataManagerRevised<Long,DTOKlassen,KlassenDaten>
de.svws_nrw.data.klassen.DataKlassendaten
public final class DataKlassendaten extends DataManagerRevised<Long,DTOKlassen,KlassenDaten>
Data-Manager für Klassen KlassenDaten

  • Konstruktordetails

    • DataKlassendaten

      public DataKlassendaten(DBEntityManager conn)
      Erstellt ein neues Objekt dieser Klasse.
      Parameter:
      conn - DBEntityManager

  • Methodendetails

    • getById

      public KlassenDaten getById(Long id) throws ApiOperationException
      Gibt die Daten einer Klasse zu deren ID zurück.
      Setzt außer Kraft:
      getById in Klasse DataManagerRevised<Long,DTOKlassen,KlassenDaten>
      Parameter:
      id - Die ID der Klasse.
      Gibt zurück:
      die Daten der KLasse zur ID.
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getDTOByKuerzelOrASDKuerzelAndHalbjahresabschnittId

      public DTOKlassen getDTOByKuerzelOrASDKuerzelAndHalbjahresabschnittId(String kuerzel, String asdKuerzel, Long halbjahresabschnittId) throws ApiOperationException
      Fall 1 (kuerzel != null und asdKuerzel != null): Die Methode versucht im ersten Schritt ein DTOKlassen Objekt über das Kürzel und die Halbjahresabschnitt ID zu ermitteln. Wenn dies zu keinem Ergebnis führt, wird anstelle des Kürzels, das ASD-Kürzel versucht. Sollte anschließend auch keine Klasse gefunden werden, wird eine ApiOperationException geworfen. Fall 2 (kuerzel != null): Die Methode versucht ein DTOKlassen Objekt über das Kürzel und die Halbjahresabschnitt ID zu ermitteln Führt dies zu keinem Ergebnis wird eine ApiOperationException geworfen.
      Parameter:
      kuerzel - Kürzel der Klasse
      asdKuerzel - ASD-Kürzel der Klasse
      halbjahresabschnittId - ID des Halbjahresabschnittes
      Gibt zurück:
      ein DTOKlasse Objekt
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getListBySchuljahresabschnittIDAsResponse

      public jakarta.ws.rs.core.Response getListBySchuljahresabschnittIDAsResponse(Long schuljahresabschnittId) throws ApiOperationException
      Methode liefert eine Liste von KlassenDaten zur angegebenen SchuljahresabschnittID.
      Parameter:
      schuljahresabschnittId - ID des Schuljahresabschnittes
      Gibt zurück:
      Liste von KlassenDaten Objekten
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getListBySchuljahresabschnittID

      public List<KlassenDaten> getListBySchuljahresabschnittID(Long schuljahresabschnittId, boolean attachSchueler) throws ApiOperationException
      Methode liefert eine Liste von KlassenDaten zur angegebenen SchuljahresabschnittID.
      Parameter:
      schuljahresabschnittId - ID des Schuljahresabschnittes
      attachSchueler - gibt an, ob die Schüler zu den Klassen mit geladen werden sollen
      Gibt zurück:
      Liste von KlassenDaten Objekten
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getListByIdsOhneSchueler

      public List<KlassenDaten> getListByIdsOhneSchueler(List<Long> ids, Long schuljahresabschnittId) throws ApiOperationException
      Methode liefert eine Liste von KlassenDaten zu den angegebenen Klassen IDs. Die Klassen enthalten keine Schüler.
      Parameter:
      ids - IDs der abzufragenden Klassen
      schuljahresabschnittId - ID des Referenz Schuljahresabschnittes
      Gibt zurück:
      Liste von KlassenDaten Objekten
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getByIdOhneSchueler

      public KlassenDaten getByIdOhneSchueler(Long id) throws ApiOperationException
      Gibt die Daten einer Klasse zu deren ID ohne Schülerliste zurück.
      Parameter:
      id - Die ID der Klasse.
      Gibt zurück:
      die Daten der KLasse zur ID ohne Schülerliste.
      Löst aus:
      ApiOperationException - im Fehlerfall

    • deleteMultipleAsResponse

      public jakarta.ws.rs.core.Response deleteMultipleAsResponse(List<Long> ids)
      Löscht mehrere Klassen und gibt das Ergebnis der Lösch-Operationen als Liste von SimpleOperationResponse zurück.
      Setzt außer Kraft:
      deleteMultipleAsResponse in Klasse DataManagerRevised<Long,DTOKlassen,KlassenDaten>
      Parameter:
      ids - die IDs der zu löschenden Klassen
      Gibt zurück:
      die Response mit einer Liste von SimpleOperationResponse zu den angefragten Lösch-Operationen.

    • setDefaultSortierung

      public jakarta.ws.rs.core.Response setDefaultSortierung(long schuljahresabschnittId) throws ApiOperationException
      Die Methode stellt für die Klassen des angegebenen Schuljahresabschnittes eine Defaultsortierung her, in dem es Default-Werte in das Feld Sortierung.
      Parameter:
      schuljahresabschnittId - die ID des Schuljahresabschnitts
      Gibt zurück:
      die HTTP-Response
      Löst aus:
      ApiOperationException - im Fehlerfall

    • initDTO

      protected void initDTO(DTOKlassen dtoKlassen, Long newId, Map<String,Object> initAttributes) throws ApiOperationException
      Beschreibung aus Klasse kopiert: DataManagerRevised
      Initialisiert das Datenbank-DTO mit der übergebenen ID.
      Wichtig: Diese Methode muss überschrieben werden, damit die Add-Methoden ausführbar sind.
      Setzt außer Kraft:
      initDTO in Klasse DataManagerRevised<Long,DTOKlassen,KlassenDaten>
      Parameter:
      dtoKlassen - das Datenbank-DTO
      newId - die ID
      initAttributes - die Attribute zur Initialisierung
      Löst aus:
      ApiOperationException - im Fehlerfall

    • checkBeforeCreation

      public void checkBeforeCreation(Long newID, Map<String,Object> initAttributes) throws ApiOperationException
      Beschreibung aus Klasse kopiert: DataManagerRevised
      Methode prüft vor dem Erstellen eines neuen Datenbank-DTOs, ob alle Vorbedingungen zum Erstellen erfüllt sind. Standardmäßig hat diese Methode keine Implementierung. Wenn eine Prüfung durchgeführt werden soll, muss diese Methode überschrieben werden.
      Setzt außer Kraft:
      checkBeforeCreation in Klasse DataManagerRevised<Long,DTOKlassen,KlassenDaten>
      Parameter:
      newID - die neue ID für das DTO
      initAttributes - die Map mit den initialen Attributen für das neue DTO
      Löst aus:
      ApiOperationException - wird geworfen, wenn eine Vorbedingung nicht erfüllt wurde

    • mapAttribute

      protected void mapAttribute(DTOKlassen dto, String name, Object value, Map<String,Object> map) throws ApiOperationException
      Beschreibung aus Klasse kopiert: DataManagerRevised
      Führt das Mapping eines Attributes des Core-DTOs auf das zugehörige Datenbank-DTO durch.
      Wichtig: Diese Methode muss überschrieben werden, damit die Add-Methoden und Patch-Methoden ausführbar sind.
      Setzt außer Kraft:
      mapAttribute in Klasse DataManagerRevised<Long,DTOKlassen,KlassenDaten>
      Parameter:
      dto - das Datenbank-DTO
      name - der Name des Core-DTO-Attributes
      value - der Wert des Core-DTO-Attributes
      map - die map von Attribut-Namen des Core-DTOs auf den zugehörigen Attributwertes
      Löst aus:
      ApiOperationException - wenn ein Fehler bei dem Mapping auftritt

    • getDTOsByIds

      public List<DTOKlassen> getDTOsByIds(List<Long> klassenIds) throws ApiOperationException
      Die Methode ermittelt eine Liste von DTOKlassen Objekten zu den angegebenen Klassen IDs.
      Parameter:
      klassenIds - ID der Klasse
      Gibt zurück:
      Ein DTOKlassen Objekt.
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getDTOsBySchuljahresabschnittId

      public List<DTOKlassen> getDTOsBySchuljahresabschnittId(Long schuljahresabschnittId) throws ApiOperationException
      Die Methode ermittelt eine Liste von DTOKlassen Objekten zu der angegebenen Schuljahresabschnitt ID.
      Parameter:
      schuljahresabschnittId - ID des Schuljahresabschnittes
      Gibt zurück:
      Liste von Klassen zu einem Schuljahresabschnitt
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getDTO

      public DTOKlassen getDTO(Long id) throws ApiOperationException
      Die Methode ermittelt das entsprechende DTOKlassen Objekt zur angegebenen Klassen ID.
      Parameter:
      id - ID der Klasse
      Gibt zurück:
      Ein DTOKlassen Objekt.
      Löst aus:
      ApiOperationException - im Fehlerfall

    • map

      protected KlassenDaten map(DTOKlassen dto) throws ApiOperationException
      Wandelt ein DTOKlassen Objekt in ein KlassenDaten Objekt um.
      Angegeben von:
      map in Klasse DataManagerRevised<Long,DTOKlassen,KlassenDaten>
      Parameter:
      dto - DTOKlassen Objekt
      Gibt zurück:
      das neu erstellte KlassenDaten Objekt
      Löst aus:
      ApiOperationException - im Fehlerfall