Package de.svws_nrw.core.data.schule

Klasse HerkunftKatalogEintrag

java.lang.Object

de.svws_nrw.core.data.schule.HerkunftKatalogEintrag

public class HerkunftKatalogEintrag
extends Object

Diese Klasse wird bei der Kommunikation über die Open-API-Schnittstelle verwendet. Sie liefert die Werte für den Katalog der möglichen Herkünfte eines Schülers. Dieser Katalog-Einträge dienen der Kompatibilität zu den Statkue-Tabellen und der Handhabung in Schild. Für die Verwendung im SVWS-Server und -Client sollten die aufgeteilten Katalog und Core-Types verwendet werden.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
@NotNull String	beschreibung	Die textuelle Beschreibung der Herkunft.
Integer	gueltigBis	Gibt an, bis zu welchem Schuljahr der Eintrag gültig ist.
Integer	gueltigVon	Gibt an, in welchem Schuljahr der Eintrag einführt wurde.
long	id	Die ID des Katalog-Eintrags.
@NotNull String	kuerzel	Das der Herkunft eines Schülers, welches im Rahmen der amtlichen Schulstatistik verwendet wird
@NotNull List<String>	schulformen	Die Kürzel der Schulformen, bei welchen die Herkunft des Schülers vorkommen kann.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
HerkunftKatalogEintrag()	Erstellt einen Eintrag mit Standardwerten
HerkunftKatalogEintrag(long id, @NotNull String kuerzel, @NotNull List<String> schulformen, @NotNull String beschreibung, Integer gueltigVon, Integer gueltigBis)	Erstellt einen Eintrag mit den angegebenen Werten

Methodenübersicht

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

id

public long id

Die ID des Katalog-Eintrags.

kuerzel

@NotNull
public @NotNull String kuerzel

Das der Herkunft eines Schülers, welches im Rahmen der amtlichen Schulstatistik verwendet wird

schulformen

@NotNull
public @NotNull List<String> schulformen

Die Kürzel der Schulformen, bei welchen die Herkunft des Schülers vorkommen kann.

beschreibung

@NotNull
public @NotNull String beschreibung

Die textuelle Beschreibung der Herkunft.

gueltigVon

public Integer gueltigVon

Gibt an, in welchem Schuljahr der Eintrag einführt wurde. Ist kein Schuljahr bekannt, so ist null gesetzt.

gueltigBis

public Integer gueltigBis

Gibt an, bis zu welchem Schuljahr der Eintrag gültig ist. Ist kein Schuljahr bekannt, so ist null gesetzt.

Konstruktordetails

HerkunftKatalogEintrag

public HerkunftKatalogEintrag()

Erstellt einen Eintrag mit Standardwerten

HerkunftKatalogEintrag

public HerkunftKatalogEintrag(long id,
 @NotNull
 @NotNull String kuerzel,
 @NotNull
 @NotNull List<String> schulformen,
 @NotNull
 @NotNull String beschreibung,
 Integer gueltigVon,
 Integer gueltigBis)

Erstellt einen Eintrag mit den angegebenen Werten

Parameter:

id - die ID

kuerzel - das Kürzel der Herkunft

schulformen - die Schulformen, für welche die Herkunft zulässig ist

beschreibung - die textuelle Beschreibung der Herkunft

gueltigVon - das Schuljahr, wann der Eintrag eingeführt wurde oder null, falls es nicht bekannt ist und "schon immer gültig war"

gueltigBis - das Schuljahr, bis zu welchem der Eintrag gültig ist