Package de.svws_nrw.data.schueler

Klasse DataSchuelerLernabschnittsdaten

java.lang.Object

de.svws_nrw.data.DataManagerRevised<Long,DTOSchuelerLernabschnittsdaten,SchuelerLernabschnittsdaten>

de.svws_nrw.data.schueler.DataSchuelerLernabschnittsdaten

public final class DataSchuelerLernabschnittsdaten
extends DataManagerRevised<Long,DTOSchuelerLernabschnittsdaten,SchuelerLernabschnittsdaten>

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

Feldübersicht

Von Klasse geerbte Felder de.svws_nrw.data.DataManagerRevised

conn

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DataSchuelerLernabschnittsdaten(DBEntityManager conn)	Erstellt einen neuen DataManagerRevised für den Core-DTO SchuelerLernabschnittsdaten.

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<DTOSchuelerLernabschnittsdaten> dtos)	Methode prüft vor dem Löschen, ob alle Vorbedingungen zum Löschen erfüllt sind.
void	checkBeforePatch(DTOSchuelerLernabschnittsdaten 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	get(Long schueler_id, long schuljahresabschnitt)	Bestimmt die Lernabschnittsdaten zur Wechsel-Nr. 0 (aktiver Abschnitt im Schuljahresabschnitt) anhand der übergebenen Schüler-ID und dem angegebenen Schuljahresabschnitt
SchuelerLernabschnittsdaten	getById(Long id)	Ermittelt das Core-DTO mit der angegebenen ID.
SchuelerLernabschnittsdaten	getFromSchuelerIDUndSchuljahresabschnittID(Long schueler_id, long schuljahresabschnitt_id)	Bestimmt die Lernabschnittsdaten anhand der übergebenen Schüler-ID und dem angegebenen Schuljahresabschnitt.
List<SchuelerLernabschnittsdaten>	getListFromSchuelerIDs(List<Long> schueler_ids, boolean mitWechseln)	Erstellt eine Liste von Lernabschnittsdaten anhand der übergebenen Schüler-IDs.
List<SchuelerLernabschnittsdaten>	getListFromSchuelerIDsUndSchuljahresabschnittID(List<Long> schueler_ids, long schuljahresabschnitt_id, boolean mitWechseln)	Erstellt eine Liste von Lernabschnittsdaten anhand der übergebenen Schüler-IDs und dem angegebenen Schuljahresabschnitt.
protected void	initDTO(DTOSchuelerLernabschnittsdaten 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.
SchuelerLernabschnittsdaten	map(DTOSchuelerLernabschnittsdaten dto)	Wandelt das Datenbank-DTO in das Core-DTO um, soweit die Daten in dem Datenbank-DTO enthalten sind.
protected void	mapAttribute(DTOSchuelerLernabschnittsdaten 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	patchBemerkungen(Long id, InputStream is)	Für einen Patch für die angegebenen Bemerkungsfelder aus.

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, getList, 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

DataSchuelerLernabschnittsdaten

public DataSchuelerLernabschnittsdaten(DBEntityManager conn)

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

Parameter:

conn - die Datenbank-Verbindung für den Datenbankzugriff

Methodendetails

initDTO

protected void initDTO(DTOSchuelerLernabschnittsdaten 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,DTOSchuelerLernabschnittsdaten,SchuelerLernabschnittsdaten>

Parameter:

dto - das Datenbank-DTO

newId - die ID

initAttributes - die Attribute zur Initialisierung

Löst aus:

ApiOperationException - im Fehlerfall

map

public SchuelerLernabschnittsdaten map(DTOSchuelerLernabschnittsdaten 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,DTOSchuelerLernabschnittsdaten,SchuelerLernabschnittsdaten>

Parameter:

dto - das Datenbank-DTO

Gibt zurück:

das neu erstellte Core-DTO

Löst aus:

ApiOperationException - im Fehlerfall

mapAttribute

protected void mapAttribute(DTOSchuelerLernabschnittsdaten 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,DTOSchuelerLernabschnittsdaten,SchuelerLernabschnittsdaten>

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,DTOSchuelerLernabschnittsdaten,SchuelerLernabschnittsdaten>

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(DTOSchuelerLernabschnittsdaten 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,DTOSchuelerLernabschnittsdaten,SchuelerLernabschnittsdaten>

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<DTOSchuelerLernabschnittsdaten> 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,DTOSchuelerLernabschnittsdaten,SchuelerLernabschnittsdaten>

Parameter:

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

Löst aus:

ApiOperationException - im Fehlerfall

getById

public SchuelerLernabschnittsdaten 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,DTOSchuelerLernabschnittsdaten,SchuelerLernabschnittsdaten>

Parameter:

id - die ID

Gibt zurück:

das Core-DTO

Löst aus:

ApiOperationException - im Fehlerfall

get

public jakarta.ws.rs.core.Response get(Long schueler_id,
 long schuljahresabschnitt)
                                throws ApiOperationException

Bestimmt die Lernabschnittsdaten zur Wechsel-Nr. 0 (aktiver Abschnitt im Schuljahresabschnitt) anhand der übergebenen Schüler-ID und dem angegebenen Schuljahresabschnitt

Parameter:

schueler_id - die Schüler-ID

schuljahresabschnitt - der Schuljahresabschnitt

Gibt zurück:

die Lernabschnittsdaten

Löst aus:

ApiOperationException - im Fehlerfall

getFromSchuelerIDUndSchuljahresabschnittID

public SchuelerLernabschnittsdaten getFromSchuelerIDUndSchuljahresabschnittID(Long schueler_id,
 long schuljahresabschnitt_id)
                                                                       throws ApiOperationException

Bestimmt die Lernabschnittsdaten anhand der übergebenen Schüler-ID und dem angegebenen Schuljahresabschnitt.

Parameter:

schueler_id - die Schüler-ID

schuljahresabschnitt_id - der Schuljahresabschnitt

Gibt zurück:

die Lernabschnittsdaten zu den übergebenen IDs.

Löst aus:

ApiOperationException - im Fehlerfall

getListFromSchuelerIDs

public List<SchuelerLernabschnittsdaten> getListFromSchuelerIDs(List<Long> schueler_ids,
 boolean mitWechseln)
                                                         throws ApiOperationException

Erstellt eine Liste von Lernabschnittsdaten anhand der übergebenen Schüler-IDs.

Parameter:

schueler_ids - die Liste mit Schüler-IDs

mitWechseln - legt fest, ob auch die Lernabschnitte berücksichtigt werden soll, die durch einen Wechsel entstanden sind, also Abschnitt mit Wechsel-Nr größer 0.

Gibt zurück:

die Lernabschnittsdaten zu den übergebenen IDs.

Löst aus:

ApiOperationException - im Fehlerfall

getListFromSchuelerIDsUndSchuljahresabschnittID

public List<SchuelerLernabschnittsdaten> getListFromSchuelerIDsUndSchuljahresabschnittID(List<Long> schueler_ids,
 long schuljahresabschnitt_id,
 boolean mitWechseln)
                                                                                  throws ApiOperationException

Erstellt eine Liste von Lernabschnittsdaten anhand der übergebenen Schüler-IDs und dem angegebenen Schuljahresabschnitt.

Parameter:

schueler_ids - die Liste mit Schüler-IDs

schuljahresabschnitt_id - der Schuljahresabschnitt

mitWechseln - legt fest, ob auch die Lernabschnitte berücksichtigt werden soll, die durch einen Wechsel entstanden sind, also Abschnitt mit Wechsel-Nr größer 0.

Gibt zurück:

die Lernabschnittsdaten zu den übergebenen IDs.

Löst aus:

ApiOperationException - im Fehlerfall

patchBemerkungen

public jakarta.ws.rs.core.Response patchBemerkungen(Long id,
 InputStream is)
                                             throws ApiOperationException

Für einen Patch für die angegebenen Bemerkungsfelder aus.

Parameter:

id - die ID des Lernabschnitts

is - ein Input-Stream mit den JSON-Daten des Patches

Gibt zurück:

die HTTP-Response für den Patch

Löst aus:

ApiOperationException - im Fehlerfall