de.svws_nrw.asd.data.schule.Schuljahresabschnitt 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.schule;

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

/**
 * Diese Klasse wird bei der Kommunikation über die Open-API-Schnittstelle verwendet.
 * Sie beschreibt einen Abschnitt eines Schuljahres.
 */
@XmlRootElement
@Schema(description = "Ein Abschnitt eines Schuljahres (z.B. Quartal / Halbjahr).")
@TranspilerDTO
public class Schuljahresabschnitt {

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

	/** Das Schuljahr, in welchem der Schuljahresabschnitt liegt */
	@Schema(description = "Das Schuljahr, in welchem der Abschnitt liegt", example = "2024")
	public int schuljahr;

	/** Die Nummer des Abschnitts im Schuljahr */
	@Schema(description = "Die Nummer des Abschnitts im Schuljahr", example = "2")
	public int abschnitt;

	/** Die ID des vorigen Schuljahresabschnittes */
	@Schema(description = "die ID des vorigen Schuljahresabschnittes", example = "4710")
	public Long idVorigerAbschnitt = null;

	/** Die ID des folgenden Schuljahresabschnittes */
	@Schema(description = "die ID des folgenden Schuljahresabschnittes", example = "4712")
	public Long idFolgeAbschnitt = null;

}