Package de.svws_nrw.data.schueler

Klasse DataSchuelerSprachbelegung

java.lang.Object

de.svws_nrw.data.DataManagerRevised<Long,DTOSchuelerSprachenfolge,Sprachbelegung>

de.svws_nrw.data.schueler.DataSchuelerSprachbelegung

public final class DataSchuelerSprachbelegung
extends DataManagerRevised<Long,DTOSchuelerSprachenfolge,Sprachbelegung>

Diese Klasse erweitert den abstrakten DataManagerRevised für den Core-DTO Sprachbelegung.

Feldübersicht

Von Klasse geerbte Felder de.svws_nrw.data.DataManagerRevised

conn

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DataSchuelerSprachbelegung(DBEntityManager conn, long idSchueler)	Erstellt einen neuen DataManagerRevised für den Core-DTO Sprachbelegung.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	checkBeforeCreation(Long newID, Map<String,Object> initAttributes)	Methode prüft vor dem Erstellen eines neuen Datenbank-DTOs, ob alle Vorbedingungen zum Erstellen erfüllt sind.
void	checkBeforeDeletion(List<DTOSchuelerSprachenfolge> dtos)	Methode prüft vor dem Löschen, ob alle Vorbedingungen zum Löschen erfüllt sind.
void	checkBeforePatch(DTOSchuelerSprachenfolge dto, Map<String,Object> patchAttributes)	Methode prüft vor dem Patchen eines Datenbank-DTOs, ob alle Vorbedingungen zum Patch erfüllt sind.
jakarta.ws.rs.core.Response	deleteByKuerzelAsResponse(@NotNull String kuerzel)	Löscht eine Sprachbelegung anhand des übergebenen Sprachkürzels und der Schüler-ID.
Sprachbelegung	getById(Long id)	Ermittelt das Core-DTO mit der angegebenen ID.
Sprachbelegung	getByKuerzel(@NotNull String kuerzel)	Bestimmt die Sprachbelegung anhand des übergebenen Sprachkürzels und der Schüler-ID.
jakarta.ws.rs.core.Response	getByKuerzelAsResponse(@NotNull String kuerzel)	Bestimmt das DTO anhand des übergebenen Kürzels der Sprachbelegung und der Schüler-ID
List<Sprachbelegung>	getList()	Ermittelt eine Liste mit Core-DTOs aus der DB.
List<Sprachbelegung>	getListSprachbelegungen()	Gibt die Liste der Sprachbelegungen des Schülers zurück.
protected void	initDTO(DTOSchuelerSprachenfolge dto, Long newId, Map<String,Object> initAttributes)	Initialisiert das Datenbank-DTO mit der übergebenen ID. Wichtig: Diese Methode muss überschrieben werden, damit die Add-Methoden ausführbar sind.
Sprachbelegung	map(DTOSchuelerSprachenfolge dto)	Wandelt das Datenbank-DTO in das Core-DTO um, soweit die Daten in dem Datenbank-DTO enthalten sind.
protected void	mapAttribute(DTOSchuelerSprachenfolge dto, String name, Object value, Map<String,Object> map)	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.
jakarta.ws.rs.core.Response	patchByKuerzelAsResponse(@NotNull String kuerzel, InputStream is)	Passt die Informationen der Sprachbelegung mit dem übergebenen Sprach-Kürzel des Schülers mithilfe des JSON-Patches aus dem übergebenen InputStream an.

Von Klasse geerbte Methoden de.svws_nrw.data.DataManagerRevised

add, addAsResponse, addBasic, addFromMapAsResponse, addFromStream, addMultiple, addMultipleAsResponse, applyPatchMappings, checkBenutzerFunktionsbezogeneKompetenzAbiturjahrgang, checkBenutzerFunktionsbezogeneKompetenzKlasse, createNextLongID, deleteAsResponse, deleteDatabaseDTO, deleteMultipleAsResponse, getAll, getAllAsResponse, getByIdAsResponse, getID, getListAsResponse, getNextID, hatBenutzerNurFunktionsbezogeneKompetenz, mapList, newDTO, patch, patchAsResponse, patchFromStream, patchMultipleAsResponse, saveDatabaseDTO, setAttributesDelayedOnCreation, setAttributesNotPatchable, setAttributesRequiredOnCreation

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

DataSchuelerSprachbelegung

public DataSchuelerSprachbelegung(DBEntityManager conn,
 long idSchueler)

Erstellt einen neuen DataManagerRevised für den Core-DTO Sprachbelegung.

Parameter:

conn - die Datenbank-Verbindung für den Datenbankzugriff

idSchueler - die ID des Schülers

Methodendetails

initDTO

protected void initDTO(DTOSchuelerSprachenfolge 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,DTOSchuelerSprachenfolge,Sprachbelegung>

Parameter:

dto - das Datenbank-DTO

newId - die ID

initAttributes - die Attribute zur Initialisierung

Löst aus:

ApiOperationException - im Fehlerfall

map

public Sprachbelegung map(DTOSchuelerSprachenfolge dto)
                   throws ApiOperationException

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,DTOSchuelerSprachenfolge,Sprachbelegung>

Parameter:

dto - das Datenbank-DTO

Gibt zurück:

das neu erstellte Core-DTO

Löst aus:

ApiOperationException - im Fehlerfall

mapAttribute

protected void mapAttribute(DTOSchuelerSprachenfolge 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,DTOSchuelerSprachenfolge,Sprachbelegung>

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

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,DTOSchuelerSprachenfolge,Sprachbelegung>

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

checkBeforePatch

public void checkBeforePatch(DTOSchuelerSprachenfolge dto,
 Map<String,Object> patchAttributes)
                      throws ApiOperationException

Beschreibung aus Klasse kopiert: DataManagerRevised

Methode prüft vor dem Patchen eines Datenbank-DTOs, ob alle Vorbedingungen zum Patch 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:

checkBeforePatch in Klasse DataManagerRevised<Long,DTOSchuelerSprachenfolge,Sprachbelegung>

Parameter:

dto - das DTO

patchAttributes - die Map mit den zu patchenden Attributen für das DTO

Löst aus:

ApiOperationException - wird geworfen, wenn eine Vorbedingung nicht erfüllt wurde

checkBeforeDeletion

public void checkBeforeDeletion(List<DTOSchuelerSprachenfolge> dtos)
                         throws ApiOperationException

Beschreibung aus Klasse kopiert: DataManagerRevised

Methode prüft vor dem Löschen, ob alle Vorbedingungen zum Löschen 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:

checkBeforeDeletion in Klasse DataManagerRevised<Long,DTOSchuelerSprachenfolge,Sprachbelegung>

Parameter:

dtos - die Datanbank-DTOs, die gelöscht werden sollen

Löst aus:

ApiOperationException - im Fehlerfall

getList

public List<Sprachbelegung> getList()
                             throws ApiOperationException

Beschreibung aus Klasse kopiert: DataManagerRevised

Ermittelt eine Liste mit Core-DTOs aus der DB. Wenn bei dieser Methode eine Filterung in der abgeleiteten Klasse genutzt wird, so steht als zweite Option die Methode DataManagerRevised.getAll() zur Verfügung, um den Abruf aller Core-DTOs zu implementieren. Wichtig: Diese Methode muss überschrieben werden, damit die Methode DataManagerRevised.getListAsResponse() ausführbar ist.

Setzt außer Kraft:

getList in Klasse DataManagerRevised<Long,DTOSchuelerSprachenfolge,Sprachbelegung>

Gibt zurück:

eine Liste der Core-DTOs

Löst aus:

ApiOperationException - im Fehlerfall

getListSprachbelegungen

public List<Sprachbelegung> getListSprachbelegungen()

Gibt die Liste der Sprachbelegungen des Schülers zurück. Im Fehlerfall ist diese Liste leer.

Gibt zurück:

Die Liste der Sprachbelegungen des Schülers

getById

public Sprachbelegung 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,DTOSchuelerSprachenfolge,Sprachbelegung>

Parameter:

id - die ID

Gibt zurück:

das Core-DTO

Löst aus:

ApiOperationException - im Fehlerfall

getByKuerzel

public Sprachbelegung getByKuerzel(@NotNull
 @NotNull String kuerzel)
                            throws ApiOperationException

Bestimmt die Sprachbelegung anhand des übergebenen Sprachkürzels und der Schüler-ID.

Parameter:

kuerzel - das Sprach-Kürzel

Gibt zurück:

die Sprachbelegung

Löst aus:

ApiOperationException - im Fehlerfall

getByKuerzelAsResponse

public jakarta.ws.rs.core.Response getByKuerzelAsResponse(@NotNull
 @NotNull String kuerzel)
                                                   throws ApiOperationException

Bestimmt das DTO anhand des übergebenen Kürzels der Sprachbelegung und der Schüler-ID

Parameter:

kuerzel - das Kürzel der Sprachbelegung

Gibt zurück:

die Sprachbelegung als Response

Löst aus:

ApiOperationException - im FehlerFall

patchByKuerzelAsResponse

public jakarta.ws.rs.core.Response patchByKuerzelAsResponse(@NotNull
 @NotNull String kuerzel,
 InputStream is)
                                                     throws ApiOperationException

Passt die Informationen der Sprachbelegung mit dem übergebenen Sprach-Kürzel des Schülers mithilfe des JSON-Patches aus dem übergebenen InputStream an.

Parameter:

kuerzel - das Sprachkürzel

is - der Input-Stream

Gibt zurück:

die HTTP-Response

Löst aus:

ApiOperationException - im Fehlerfall

deleteByKuerzelAsResponse

public jakarta.ws.rs.core.Response deleteByKuerzelAsResponse(@NotNull
 @NotNull String kuerzel)
                                                      throws ApiOperationException

Löscht eine Sprachbelegung anhand des übergebenen Sprachkürzels und der Schüler-ID.

Parameter:

kuerzel - das Kürzel der Sprache

Gibt zurück:

die HTTP-Response, welchen den Erfolg der Lösch-Operation angibt.

Löst aus:

ApiOperationException - im Fehlerfall