Package de.svws_nrw.core.data.schule

Klasse AllgemeineMerkmaleKatalogEintrag

java.lang.Object

de.svws_nrw.core.data.schule.AllgemeineMerkmaleKatalogEintrag

public class AllgemeineMerkmaleKatalogEintrag
extends Object

Diese Klasse wird bei der Kommunikation über die Open-API-Schnittstelle verwendet. Sie liefert die Werte für den Katalog der allgemeinen Merkmale bei Schulen und Schüler.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
boolean	beiSchueler	Gibt an, das das Merkmal bei einem Schüler gesetzt werden kann.
boolean	beiSchule	Gibt an, das das Merkmal bei der Schule gesetzt werden kann.
@NotNull String	bezeichnung	Eine kurze Bezeichnung für das allgemeine Merkmal.
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 Kürzel des allgemeinen Merkmals
String	kuerzelASD	Ggf. ein Kürzel, welches im Rahmen der amtlichen Schulstatistik verwendet wird.
@NotNull List<String>	schulformen	Die Kürzel der Schulformen, bei welchen das allgemeine Merkmal vorkommen kann.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AllgemeineMerkmaleKatalogEintrag()	Erstellt einen Eintrag mit Standardwerten
AllgemeineMerkmaleKatalogEintrag(long id, @NotNull String kuerzel, @NotNull String bezeichnung, boolean beiSchule, boolean beiSchueler, String kuerzelASD, @NotNull List<Schulform> schulformen, 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 Kürzel des allgemeinen Merkmals

bezeichnung

@NotNull
public @NotNull String bezeichnung

Eine kurze Bezeichnung für das allgemeine Merkmal.

beiSchule

public boolean beiSchule

Gibt an, das das Merkmal bei der Schule gesetzt werden kann.

beiSchueler

public boolean beiSchueler

Gibt an, das das Merkmal bei einem Schüler gesetzt werden kann.

kuerzelASD

public String kuerzelASD

Ggf. ein Kürzel, welches im Rahmen der amtlichen Schulstatistik verwendet wird.

schulformen

@NotNull
public @NotNull List<String> schulformen

Die Kürzel der Schulformen, bei welchen das allgemeine Merkmal vorkommen kann.

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

AllgemeineMerkmaleKatalogEintrag

public AllgemeineMerkmaleKatalogEintrag()

Erstellt einen Eintrag mit Standardwerten

AllgemeineMerkmaleKatalogEintrag

public AllgemeineMerkmaleKatalogEintrag(long id,
 @NotNull
 @NotNull String kuerzel,
 @NotNull
 @NotNull String bezeichnung,
 boolean beiSchule,
 boolean beiSchueler,
 String kuerzelASD,
 @NotNull
 @NotNull List<Schulform> schulformen,
 Integer gueltigVon,
 Integer gueltigBis)

Erstellt einen Eintrag mit den angegebenen Werten

Parameter:

id - die ID

kuerzel - das Kürzel

bezeichnung - die Bezeichnung des Merkmals

beiSchule - gibt an, das das Merkmal bei der Schule gesetzt werden kann

beiSchueler - gibt an, das das Merkmal bei einem Schüler gesetzt werden kann

kuerzelASD - ggf. ein Kürzel, welches im Rahmen der amtlichen Schulstatistik verwendet wird

schulformen - die Schulformen, bei welchen das allgemeine Merkmal vorkommen kann

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