Package de.svws_nrw.data.faecher

Klasse DataFaecher

java.lang.Object
de.svws_nrw.data.DataManagerRevised<Long,DTOFach,FachDaten>
de.svws_nrw.data.faecher.DataFaecher
public final class DataFaecher extends DataManagerRevised<Long,DTOFach,FachDaten>
Diese Klasse erweitert den abstrakten DataManagerRevised für das Core-DTO FachDaten.

  • Konstruktordetails

  • Methodendetails

    • initDTO

      protected void initDTO(DTOFach dto, 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,DTOFach,FachDaten>
      Parameter:
      dto - das Datenbank-DTO
      newId - die ID
      initAttributes - die Attribute zur Initialisierung
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getById

      public FachDaten getById(Long id) throws ApiOperationException
      Beschreibung aus Klasse kopiert: DataManagerRevised
      Ermittelt das Core-DTO mit der angegebenen ID. Wichtig: Diese Methode muss überschrieben werden, damit die Methode DataManagerRevised.getByIdAsResponse(Object) ausführbar ist.
      Setzt außer Kraft:
      getById in Klasse DataManagerRevised<Long,DTOFach,FachDaten>
      Parameter:
      id - die ID
      Gibt zurück:
      das Core-DTO
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getLongId

      protected long getLongId(DTOFach fach)
      Beschreibung aus Klasse kopiert: DataManagerRevised
      Diese Methode muss überschrieben werden, damit die Methode deleteMultipleAsSimpleResponseList genutzt werden kann. Sie ermittelt zu den übergeben Datenbank-DTO den long-Wert der zugehörigen ID.
      Setzt außer Kraft:
      getLongId in Klasse DataManagerRevised<Long,DTOFach,FachDaten>
      Parameter:
      fach - das Datenbank-DTO
      Gibt zurück:
      der long-Wert der ID

    • map

      protected FachDaten map(DTOFach dto)
      Beschreibung aus Klasse kopiert: DataManagerRevised
      Wandelt das Datenbank-DTO in das Core-DTO um, soweit die Daten in dem Datenbank-DTO enthalten sind.
      Angegeben von:
      map in Klasse DataManagerRevised<Long,DTOFach,FachDaten>
      Parameter:
      dto - das Datenbank-DTO
      Gibt zurück:
      das neu erstellte Core-DTO

    • mapAttribute

      protected void mapAttribute(DTOFach 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,DTOFach,FachDaten>
      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

    • getMapFachdatenFromDTOFachList

      public Map<Long,FachDaten> getMapFachdatenFromDTOFachList(List<DTOFach> dtoFaecher) throws ApiOperationException
      Mappt eine Liste von DTOFach Objekten zu FachDaten nach Id
      Parameter:
      dtoFaecher - Liste der Fach-DTOs, aus denen die Map erstellt werden soll.
      Gibt zurück:
      Map der Fachdaten zur Fach-ID.
      Löst aus:
      ApiOperationException - im Fehlerfall

    • checkBeforeDeletionWithSimpleOperationResponse

      protected void checkBeforeDeletionWithSimpleOperationResponse(List<DTOFach> faecher, Map<Long,SimpleOperationResponse> mapResponses)
      Beschreibung aus Klasse kopiert: DataManagerRevised
      Methode prüft vor dem Löschen, ob alle Vorbedingungen zum Löschen erfüllt sind und hält das Ergebnis in der Map mit den SimpleOperationsResponses fest. Wenn eine Prüfung durchgeführt werden soll, muss diese Methode überschrieben werden. Ansonsten wird davon ausgegangen, dass keine Überprüfung nötig ist.
      Setzt außer Kraft:
      checkBeforeDeletionWithSimpleOperationResponse in Klasse DataManagerRevised<Long,DTOFach,FachDaten>
      Parameter:
      faecher - die Datanbank-DTOs, die gelöscht werden sollen
      mapResponses - die Map von den IDs auf die zugehörigen SimpleOperationsResponses

    • setDefaultSortierungSekII

      public static jakarta.ws.rs.core.Response setDefaultSortierungSekII(DBEntityManager conn) throws ApiOperationException
      Setzt für die Fächer der Fächerliste Default-Werte in das Feld Sortierung. Diese orientieren sich an der Sortierreihenfolge der Fächer der Oberstufe. Fächer, die nicht der Oberstufe zugeordnet werden können werden mit der ursprünglichen Sortierung angehangen.
      Parameter:
      conn - die Datenbankverbindung
      Gibt zurück:
      die HTTP-Response
      Löst aus:
      ApiOperationException - im Fehlerfall

    • getFaecherListe

      public List<FachDaten> getFaecherListe(boolean includeReferenzInfo)
      Bestimmt die Liste aller Fächer.
      Parameter:
      includeReferenzInfo - wenn True erhalten die Daten die Information, ob das Fach in anderen Datenbanktabellen referenziert ist oder nicht. Dies erfordert eine zusätzliche Datenbankabfrage und ist aus daher Performancegründen nur empfohlen, wenn diese Information benötigt wird.
      Gibt zurück:
      die Liste der Fächer oder leere Liste

    • getAll

      public List<FachDaten> getAll()
      Beschreibung aus Klasse kopiert: DataManagerRevised
      Ermittelt eine Liste mit allen Core-DTOs aus der DB. Wird in seltenen Fällen verwendet, wenn auch eine Filterung bei der Methode DataManagerRevised.getList() implementiert wird. Wichtig: Diese Methode muss überschrieben werden, damit die Methode DataManagerRevised.getAllAsResponse() ausführbar ist.
      Setzt außer Kraft:
      getAll in Klasse DataManagerRevised<Long,DTOFach,FachDaten>
      Gibt zurück:
      eine Liste der Core-DTOs