Package de.svws_nrw.data.schueler

Klasse DataSchuelerLernplattformen

java.lang.Object

de.svws_nrw.data.DataManagerRevised<Long[],DTOSchuelerLernplattform,SchuelerLernplattform>

de.svws_nrw.data.schueler.DataSchuelerLernplattformen

public final class DataSchuelerLernplattformen
extends DataManagerRevised<Long[],DTOSchuelerLernplattform,SchuelerLernplattform>

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

Feldübersicht

Von Klasse geerbte Felder de.svws_nrw.data.DataManagerRevised

classDatabaseDTO, conn

Konstruktorübersicht

Konstruktoren

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

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<SchuelerLernplattform>	getAll()	Ermittelt eine Liste mit allen Core-DTOs aus der DB.
SchuelerLernplattform	getById(Long[] id)	Ermittelt das Core-DTO mit der angegebenen ID.
DTOSchuelerLernplattform	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<SchuelerLernplattform>	getList()	Ermittelt eine Liste mit Core-DTOs aus der DB.
protected void	initDTO(DTOSchuelerLernplattform 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.
SchuelerLernplattform	map(DTOSchuelerLernplattform dtoLernplattform)	Wandelt das Datenbank-DTO in das Core-DTO um, soweit die Daten in dem Datenbank-DTO enthalten sind.
SchuelerLernplattform	map(DTOSchuelerLernplattform dtoLernplattform, String benutzername, String initialkennwort)	Konvertiert ein DTOLernplattformen-Objekt in ein Lernplattform-Objekt und setzt den Benutzernamen und das Initialkennwort.
protected void	mapAttribute(DTOSchuelerLernplattform 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

DataSchuelerLernplattformen

public DataSchuelerLernplattformen(DBEntityManager conn,
 Long idSchueler)

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

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 SchuelerLernplattform map(DTOSchuelerLernplattform dtoLernplattform)

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[],DTOSchuelerLernplattform,SchuelerLernplattform>

Parameter:

dtoLernplattform - das Datenbank-DTO

Gibt zurück:

das neu erstellte Core-DTO

map

public SchuelerLernplattform map(DTOSchuelerLernplattform dtoLernplattform,
 String benutzername,
 String initialkennwort)

Konvertiert ein DTOLernplattformen-Objekt in ein Lernplattform-Objekt und setzt den Benutzernamen und das Initialkennwort.

Parameter:

dtoLernplattform - Das DTOLernplattformen-Objekt, das konvertiert werden soll.

benutzername - Der Benutzername zu der Lernplattform, das gesetzt werden sollen.

initialkennwort - Das Initialkennwort zu der Lernplattform, das gesetzt werden sollen.

Gibt zurück:

Ein Lernplattform-Objekt, das aus dem DTOLernplattformen-Objekt konvertiert und mit den der Benutzername und das Initialkennwort gesetzt wurde.

getAll

public List<SchuelerLernplattform> 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[],DTOSchuelerLernplattform,SchuelerLernplattform>

Gibt zurück:

eine Liste der Core-DTOs

Löst aus:

ApiOperationException - im Fehlerfall

getList

public List<SchuelerLernplattform> getList()

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[],DTOSchuelerLernplattform,SchuelerLernplattform>

Gibt zurück:

eine Liste der Core-DTOs

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[],DTOSchuelerLernplattform,SchuelerLernplattform>

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(DTOSchuelerLernplattform 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[],DTOSchuelerLernplattform,SchuelerLernplattform>

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[],DTOSchuelerLernplattform,SchuelerLernplattform>

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(DTOSchuelerLernplattform 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[],DTOSchuelerLernplattform,SchuelerLernplattform>

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 SchuelerLernplattform 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[],DTOSchuelerLernplattform,SchuelerLernplattform>

Parameter:

id - die ID

Gibt zurück:

das Core-DTO

Löst aus:

ApiOperationException - im Fehlerfall

getDatabaseDTOByID

public DTOSchuelerLernplattform 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[],DTOSchuelerLernplattform,SchuelerLernplattform>

Parameter:

id - die ID

Gibt zurück:

das Database-DTO