de.svws_nrw.asd.data.lehrer.LehrerPersonaldaten Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of svws-asd Show documentation
Diese Bibliothek stellt grundlegende Datenypen und Algorithmen für die Prüfung der amtlichen Schuldaten in NRW bereit
There is a newer version: 1.0.0
package de.svws_nrw.asd.data.lehrer;

import java.util.ArrayList;
import java.util.List;

import de.svws_nrw.transpiler.TranspilerDTO;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;
import jakarta.xml.bind.annotation.XmlRootElement;

/**
 * Diese Klasse wird bei der Kommunikation über die Open-API-Schnittstelle verwendet.
 * Sie beschreibt die Personaldaten eines Lehrers mit der übergebenen ID.
 */
@XmlRootElement
@Schema(description = "Die Personaldaten eines Lehrer-Eintrags.")
@TranspilerDTO
public class LehrerPersonaldaten {

	/** Die ID des Lehrers. */
	@Schema(description = "Die ID des Lehrers.", example = "4711")
	public long id;

	/** Der vordere Teil der NRW-weit eindeutigen Ident-Nummer - setzt sich normalerweise aus Geburtsdatum und Geschlecht (3/4) zusammen, kann in Einzelfällen aber von diesem Schema abweichen. */
	@Schema(description = "Der vordere Teil der NRW-weit eindeutigen Ident-Nummer - setzt sich normalerweise aus Geburtsdatum und Geschlecht (3/4) zusammen, kann in Einzelfällen aber von diesem Schema abweichen.", example = "1708593")
	public String identNrTeil1;

	/** Der hintere Teil der Ident-Nummer – wird üblicherweise NRW-weit fortlaufend vergeben. */
	@Schema(description = "Der hintere Teil der Ident-Nummer – wird üblicherweise NRW-weit fortlaufend vergeben.", example = "")
	public String identNrTeil2SerNr;

	/** Die Personalaktennummer des Lehrers für den Export zu GPC. */
	@Schema(description = "Die Personalaktennummer des Lehrers für den Export zu GPC.", example = "")
	public String personalaktennummer;

	/** Die Personalnummer des LBV. */
	@Schema(description = "Die Personalnummer des LBV.", example = "")
	public String lbvPersonalnummer;

	/** Der zur Personalnummer gehörige Vergütungsschlüssel. */
	@Schema(description = "Der zur Personalnummer gehörige Vergütungsschlüssel.", example = "2")
	public String lbvVerguetungsschluessel;

	/** Das Datum, wann der Lehrer an die Schule gekommen ist. */
	@Schema(description = "Das Datum, wann der Lehrer an die Schule gekommen ist.", example = "1911-11-11")
	public String zugangsdatum;

	/** Der Grund für den Zugang des Lehrers - siehe Statistik-Katalog. */
	@Schema(description = "Der Grund für den Zugang des Lehrers - siehe Statistik-Katalog.", example = "WIEDER")
	public String zugangsgrund;

	/** Das Datum, wann der Lehrer an die Schule verlassen hat. */
	@Schema(description = "Das Datum, wann der Lehrer an die Schule verlassen hat.", example = "1920-11-12")
	public String abgangsdatum;

	/** Der Grund für den Abgang des Lehrers - siehe Statistik-Katalog. */
	@Schema(description = "Der Grund für den Abgang des Lehrers - siehe Statistik-Katalog.", example = "RUHEST")
	public String abgangsgrund;

	/** Die Abschnittsdaten des Lehrers. */
	@ArraySchema(schema = @Schema(implementation = LehrerPersonalabschnittsdaten.class, description = "Ein Array mit den Abschnittsdaten des Lehrers zu den einzelnen Schuljahresabschnitten."))
	public final @NotNull List abschnittsdaten = new ArrayList<>();

	/** Die Lehrämter des Lehrers. */
	@ArraySchema(schema = @Schema(implementation = LehrerLehramtEintrag.class, description = "Ein Array mit den Lehrämtern des Lehrers."))
	public final @NotNull List lehraemter = new ArrayList<>();

	/** Die Fachrichtungen des Lehrers. */
	@ArraySchema(schema = @Schema(implementation = LehrerFachrichtungEintrag.class, description = "Ein Array mit den Fachrichtungen des Lehrers."))
	public final @NotNull List fachrichtungen = new ArrayList<>();

	/** Die Lehrbefähigungen des Lehrers. */
	@ArraySchema(schema = @Schema(implementation = LehrerLehrbefaehigungEintrag.class, description = "Ein Array mit den Lehrbefähigungen des Lehrers."))
	public final @NotNull List lehrbefaehigungen = new ArrayList<>();

}