de.svws_nrw.schulen.v1.data.SchuldateiOrganisationseinheit Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of svws-schulen Show documentation
Diese Bibliothek ermöglicht den Zugriff auf die Schulinformationen, wie sie vom Web-Service des Landes NRW bereitgestellt werden.
The newest version!
package de.svws_nrw.schulen.v1.data;

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;

/**
 * Die Klasse beschreibt eine Organisationseinheit im Rahmen der Schuldatei.
 * Den Schulen als eine Art von Organisationseinheiten sind i.A. Schulnummern
 * zwichen 100000 und 199999 zugeordnet.
 */
@XmlRootElement
@Schema(description = "eine Organisationseinheit der Schuldatei.")
@TranspilerDTO
public class SchuldateiOrganisationseinheit {

	/** Die Schulnummer der Organisationseinheit. */
	@Schema(description = "die Schulnummer der Organisationseinheit", example = "100001")
	public @NotNull String schulnummer = "";

	/** Die Bundeslandkennung (NRW) */
	@Schema(description = "die Bundeslandkennung", example = "NRW")
	public @NotNull String bundeslandkennung = "";

	/** Die eindeutige Identifier für das XSCHULE-Format */
	@Schema(description = "der Identifier der Schule für XSCHULE", example = "NRW_123456")
	public @NotNull String xscid = "";

	/** Die Art der Organisationseinheit */
	@Schema(description = "die Art der Organisationseinheit", example = "1")
	public @NotNull String oeart = "";

	/** Die Amtsbezeichnung der Organisationseinheit */
	@Schema(description = "Teil1 der amtlichen Bezeichnung der Organisationseinheit", example = "Städt. Gymnasium ....")
	public @NotNull String amtsbez1 = "";

	/** Die Amtsbezeichnung der Organisationseinheit */
	@Schema(description = "Teil2 der amtlichen Bezeichnung der Organisationseinheit", example = "Städt. Gymnasium ....")
	public @NotNull String amtsbez2 = "";

	/** Die Amtsbezeichnung der Organisationseinheit */
	@Schema(description = "Teil3 der amtlichen Bezeichnung der Organisationseinheit", example = "Städt. Gymnasium ....")
	public @NotNull String amtsbez3 = "";

	/** Das Errichtungsdatum der Schule. */
	@Schema(description = "das Errichtungsdatum der Schule", example = "01.08.1973")
	public @NotNull String errichtung = "";

	/** Das Aufloesungsdatum der Schule. */
	@Schema(description = "das Auflösungsdatum der Schule", example = "01.08.1973")
	public @NotNull String aufloesung = "";

	/** Die Grunddaten der Organisationseinheit (zeitl. Verlaufsliste)*/
	@ArraySchema(schema = @Schema(implementation = SchuldateiOrganisationseinheitGrunddaten.class))
	public final @NotNull List grunddaten = new ArrayList<>();

	/** Die Adressen der Organisationseinheit (zeitl. Verlaufsliste)*/
	@ArraySchema(schema = @Schema(implementation = SchuldateiOrganisationseinheitAdresse.class))
	public final @NotNull List adressen = new ArrayList<>();

	/** Die Merkmale der Organisationseinheit (zeitl. Verlaufsliste)*/
	@ArraySchema(schema = @Schema(implementation = SchuldateiOrganisationseinheitMerkmal.class))
	public final @NotNull List merkmal = new ArrayList<>();

	/** Die Erreichbarkeiten der Organisationseinheit (zeitl. Verlaufsliste)*/
	@ArraySchema(schema = @Schema(implementation = SchuldateiOrganisationseinheitErreichbarkeit.class))
	public final @NotNull List erreichbarkeiten = new ArrayList<>();

	/** Die Gliederungen der Organisationseinheit-Schule (zeitl. Verlaufsliste)*/
	@ArraySchema(schema = @Schema(implementation = SchuldateiOrganisationseinheitGliederung.class))
	public final @NotNull List gliederung = new ArrayList<>();

	/** Die Eigenschaften der Organisationseinheit */
	@ArraySchema(schema = @Schema(implementation = SchuldateiOrganisationseinheitEigenschaft.class))
	public final @NotNull List oeEigenschaften = new ArrayList<>();


	/**
	 * Erstellt eine neue Organiationseinheit für die Schuldatei
	 */
	public SchuldateiOrganisationseinheit() {
		// Die Initialisierung mit Defaults erfolgt direkt über die Attribute
	}

}