Package de.svws_nrw.data.schueler

Klasse DataSchuelerEinwilligungen

java.lang.Object

de.svws_nrw.data.DataManagerRevised<Long[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

de.svws_nrw.data.schueler.DataSchuelerEinwilligungen

public final class DataSchuelerEinwilligungen
extends DataManagerRevised<Long[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

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

Feldübersicht

Von Klasse geerbte Felder de.svws_nrw.data.DataManagerRevised

classDatabaseDTO, conn

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DataSchuelerEinwilligungen(DBEntityManager conn, Long idSchueler)	Erstellt einen neuen DataManagerRevised für den Core-DTO SchuelerEinwilligung.

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.
List<SchuelerEinwilligung>	getAll()	Ermittelt eine Liste mit allen Core-DTOs aus der DB.
SchuelerEinwilligung	getById(Long[] id)	Ermittelt das Core-DTO mit der angegebenen ID.
DTOSchuelerDatenschutz	getDatabaseDTOByID(Long[] id)	Ermittelt das Database-DTO mit der angegebenen ID.
protected Long[]	getID(Map<String,Object> attributes)	Erzeugt bzw. ermittelt die custom ID für ein neues oder zu veränderndes Datenbank-DTO anhand der übergebenen Attribute. Wichtig: Wird eine neue ID benötigt, die abweichend von der Default Implementierung in der Methode DataManagerRevised.createNextLongID(Long) ist oder nicht vom Typ Long ist, muss diese Methode überschrieben werden.
List<Long>	getIDsByEinwilligungsartId(Long id)	Bestimmt die IDs der Einwilligungen, welche zu der übergebenen ID der Einwilligungsart gehören.
List<SchuelerEinwilligung>	getList()	Ermittelt eine Liste mit Core-DTOs aus der DB.
List<SchuelerEinwilligung>	getListBySchuelerIds(List<Long> ids)	Liefert alle Einwilligungen für die angegebenen Schüler.
jakarta.ws.rs.core.Response	getListBySchuelerIdsAsResponse(List<Long> ids)	Liefert eine Response mit einer Liste mit SchuelerEinwilligung Objekten zu den übergebenen IDs.
protected void	initDTO(DTOSchuelerDatenschutz dto, Long[] idArray, 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.
SchuelerEinwilligung	map(DTOSchuelerDatenschutz dtoEinwilligung)	Wandelt das Datenbank-DTO in das Core-DTO um, soweit die Daten in dem Datenbank-DTO enthalten sind.
protected void	mapAttribute(DTOSchuelerDatenschutz 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.

Von Klasse geerbte Methoden de.svws_nrw.data.DataManagerRevised

add, addAsResponse, addBasic, addFromMapAsResponse, addFromStream, addMultiple, addMultipleAsResponse, applyPatchMappings, checkBeforeDeletion, checkBeforeDeletionWithSimpleOperationResponse, checkBeforePatch, checkBeforePersist, checkBenutzerFunktionsbezogeneKompetenzAbiturjahrgang, checkBenutzerFunktionsbezogeneKompetenzKlasse, createNextLongID, deleteAsResponse, deleteDatabaseDTO, deleteMultipleAsResponse, deleteMultipleAsSimpleResponseList, getAllAsResponse, getByIdAsResponse, getDatabaseDTOsByIds, getListAsResponse, getLongId, getNextID, hatBenutzerNurFunktionsbezogeneKompetenz, mapList, newDTO, patch, patchAsResponse, patchFromStream, patchMultipleAsResponse, patchSingleAsResponse, saveDatabaseDTO, setAttributesDelayedOnCreation, setAttributesNotPatchable, setAttributesRequiredOnCreation

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

DataSchuelerEinwilligungen

public DataSchuelerEinwilligungen(DBEntityManager conn,
 Long idSchueler)

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

Parameter:

conn - die Datenbank-Verbindung für den Datenbankzugriff

idSchueler - die ID des Schülerdatensatzes auf dem die Datenbankoperationen ausgeführt werden

Methodendetails

map

public SchuelerEinwilligung map(DTOSchuelerDatenschutz dtoEinwilligung)

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[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

Parameter:

dtoEinwilligung - das Datenbank-DTO

Gibt zurück:

das neu erstellte Core-DTO

getAll

public List<SchuelerEinwilligung> getAll()
                                  throws ApiOperationException

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[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

Gibt zurück:

eine Liste der Core-DTOs

Löst aus:

ApiOperationException - im Fehlerfall

getListBySchuelerIds

public List<SchuelerEinwilligung> getListBySchuelerIds(List<Long> ids)

Liefert alle Einwilligungen für die angegebenen Schüler.

Parameter:

ids - Liste der Schüler IDs, deren Einwilligungen abgerufen werden sollen.

Gibt zurück:

Alle Einwilligungen der angegebenen Schüler.

getListBySchuelerIdsAsResponse

public jakarta.ws.rs.core.Response getListBySchuelerIdsAsResponse(List<Long> ids)

Liefert eine Response mit einer Liste mit SchuelerEinwilligung Objekten zu den übergebenen IDs.

Parameter:

ids - IDs der Schüler

Gibt zurück:

die Response mit der Liste von SchuelerEinwilligung Objekten

getList

public List<SchuelerEinwilligung> 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[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

Gibt zurück:

eine Liste der Core-DTOs

Löst aus:

ApiOperationException - im Fehlerfall

getID

protected Long[] getID(Map<String,Object> attributes)
                throws ApiOperationException

Beschreibung aus Klasse kopiert: DataManagerRevised

Erzeugt bzw. ermittelt die custom ID für ein neues oder zu veränderndes Datenbank-DTO anhand der übergebenen Attribute.
Wichtig: Wird eine neue ID benötigt, die abweichend von der Default Implementierung in der Methode DataManagerRevised.createNextLongID(Long) ist oder nicht vom Typ Long ist, muss diese Methode überschrieben werden. Ebenfalls muss die Methode implementiert werden, wenn die Patch-Operation DataManagerRevised.patchMultipleAsResponse(InputStream) genutzt wird.

Setzt außer Kraft:

getID in Klasse DataManagerRevised<Long[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

Parameter:

attributes - die Map mit initialen oder zu patchenden Attributen für ein DTO

Gibt zurück:

die custom ID

Löst aus:

ApiOperationException - im Fehlerfall

initDTO

protected void initDTO(DTOSchuelerDatenschutz dto,
 Long[] idArray,
 Map<String,Object> initAttributes)

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[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

Parameter:

dto - das Datenbank-DTO

idArray - die ID

initAttributes - die Attribute zur Initialisierung

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[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

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(DTOSchuelerDatenschutz 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[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

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

getById

public SchuelerEinwilligung 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[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

Parameter:

id - die ID

Gibt zurück:

das Core-DTO

Löst aus:

ApiOperationException - im Fehlerfall

getIDsByEinwilligungsartId

public List<Long> getIDsByEinwilligungsartId(Long id)

Bestimmt die IDs der Einwilligungen, welche zu der übergebenen ID der Einwilligungsart gehören.

Parameter:

id - die ID der Einwilligungsart

Gibt zurück:

die List von Einwilligungs IDs, welche der entsprechenden Einwilligungsart zugeordnet sind

getDatabaseDTOByID

public DTOSchuelerDatenschutz getDatabaseDTOByID(Long[] id)

Beschreibung aus Klasse kopiert: DataManagerRevised

Ermittelt das Database-DTO mit der angegebenen ID. Diese Methode sollte bei Bedarf für komplexere IDs überschrieben werden.

Setzt außer Kraft:

getDatabaseDTOByID in Klasse DataManagerRevised<Long[],DTOSchuelerDatenschutz,SchuelerEinwilligung>

Parameter:

id - die ID

Gibt zurück:

das Database-DTO