de.svws_nrw.api.server.APIAlgoGesamtschuleAbschluss Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of svws-openapi Show documentation
Diese Bibliothek enthält die Java-Server-Definition der OpenApi-Schnittstelle für die Schulverwaltungssoftware in NRW
There is a newer version: 1.0.3
package de.svws_nrw.api.server;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.Context;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.Response.Status;
import de.svws_nrw.core.abschluss.ge.ServiceAbschlussHA10;
import de.svws_nrw.core.abschluss.ge.ServiceAbschlussHA9;
import de.svws_nrw.core.abschluss.ge.ServiceAbschlussMSA;
import de.svws_nrw.core.abschluss.ge.ServiceBerechtigungMSAQ;
import de.svws_nrw.core.abschluss.ge.ServicePrognose;
import de.svws_nrw.core.data.abschluss.AbschlussErgebnis;
import de.svws_nrw.core.data.abschluss.GEAbschlussFaecher;
import de.svws_nrw.db.utils.ApiOperationException;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;


/**
 * Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die Abschlussberechnung an der Gesamtschule.
 * Ein Zugriff erfolgt über den Pfad https://{Hostname}/api/gesamtschule/abschluss/...
 */
@Path("/api/gesamtschule/abschluss")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Tag(name = "ServerAlgorithmen")
public class APIAlgoGesamtschuleAbschluss {

	/**
	 * Die OpenAPI-Methode für die Prüfung auf den HA9.
	 *
	 * @param faecher       zu übergebende Fächerdaten für die Prüfung auf HA9
	 * @param request       die Informationen zur HTTP-Anfrage
	 *
	 * @return              das Ergebis der Prüfung auf HA9
	 */
	@POST
	@Path("/ha9")
	@Operation(summary = "Führt eine Prüfung auf einen Hauptschulabschluss nach der Klasse 9 an einer Gesamtschule durch.",
			description = "Prüft anhand der übergeben Fächerdaten, ob ein Hauptschulabschluss der Klasse 9 an einer Gesamtschule erreicht wird oder nicht. "
					+ "Im Falle, dass er nicht erreicht wird, werden ggf. Nachprüfungsfächer zurückgegeben.")
	@ApiResponse(responseCode = "400", description = "Es wurden ungültige Werte übergeben, so dass kein Abschluss berechnet werden kann.")
	@ApiResponse(responseCode = "200", description = "Das Ergebnis der Abschlussberechnung, ggf. mit Nachprüfungsmöglichkeiten",
			content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = AbschlussErgebnis.class)))
	public Response getGesamtschuleAbschlussHA9(
			@RequestBody(description = "Die Fächerdaten für die Abschlussberechnung", required = true,
					content = @Content(mediaType = MediaType.APPLICATION_JSON,
							schema = @Schema(implementation = GEAbschlussFaecher.class))) final GEAbschlussFaecher faecher,
			@Context final HttpServletRequest request) {
		final ServiceAbschlussHA9 ha9 = new ServiceAbschlussHA9();
		final AbschlussErgebnis daten = ha9.handle(faecher);
		if (daten == null)
			return new ApiOperationException(Status.BAD_REQUEST).getResponse();
		daten.log = ha9.getLog().getStrings();
		return Response.status(Status.OK).type(MediaType.APPLICATION_JSON).entity(daten).build();
	}



	/**
	 * Die OpenAPI-Methode für die Prüfung auf den HA10.
	 *
	 * @param faecher       zu übergebende Fächerdaten für die Prüfung auf HA10
	 * @param request       die Informationen zur HTTP-Anfrage
	 *
	 * @return              das Ergebis der Prüfung auf HA10
	 */
	@POST
	@Path("/ha10")
	@Operation(summary = "Führt eine Prüfung auf einen Hauptschulabschluss nach der Klasse 10 an einer Gesamtschule durch.",
			description = "Prüft anhand der übergeben Fächerdaten, ob ein Hauptschulabschluss der Klasse 10 an einer Gesamtschule "
					+ "erreicht wird oder nicht. Im Falle, dass er nicht erreicht wird, werden ggf. Nachprüfungsfächer zurückgegeben.")
	@ApiResponse(responseCode = "200", description = "Das Ergebnis der Abschlussberechnung, ggf. mit Nachprüfungsmöglichkeiten",
			content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = AbschlussErgebnis.class)))
	public Response getGesamtschuleAbschlussHA10(
			@RequestBody(description = "Die Fächerdaten für die Abschlussberechnung", required = true,
					content = @Content(mediaType = MediaType.APPLICATION_JSON,
							schema = @Schema(implementation = GEAbschlussFaecher.class))) final GEAbschlussFaecher faecher,
			@Context final HttpServletRequest request) {
		final ServiceAbschlussHA10 ha10 = new ServiceAbschlussHA10();
		final AbschlussErgebnis daten = ha10.handle(faecher);
		if (daten == null)
			return new ApiOperationException(Status.BAD_REQUEST).getResponse();
		daten.log = ha10.getLog().getStrings();
		return Response.status(Status.OK).type(MediaType.APPLICATION_JSON).entity(daten).build();
	}



	/**
	 * Die OpenAPI-Methode für die Prüfung auf den MSA.
	 *
	 * @param faecher       zu übergebende Fächerdaten für die Prüfung auf MSA
	 * @param request       die Informationen zur HTTP-Anfrage
	 *
	 * @return              das Ergebis der Prüfung auf MSA
	 */
	@POST
	@Path("/msa")
	@Operation(summary = "Führt eine Prüfung auf einen Mittleren Schulabschluss nach der Klasse 10 an einer Gesamtschule durch.",
			description = "Prüft anhand der übergeben Fächerdaten, ob ein Mittlerer Schulabschluss nach der Klasse 10 an einer Gesamtschule "
					+ "erreicht wird oder nicht. Im Falle, dass er nicht erreicht wird, werden ggf. Nachprüfungsfächer zurückgegeben.")
	@ApiResponse(responseCode = "200", description = "Das Ergebnis der Abschlussberechnung, ggf. mit Nachprüfungsmöglichkeiten",
			content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = AbschlussErgebnis.class)))
	public Response getGesamtschuleAbschlussMSA(
			@RequestBody(description = "Die Fächerdaten für die Abschlussberechnung", required = true,
					content = @Content(mediaType = MediaType.APPLICATION_JSON,
							schema = @Schema(implementation = GEAbschlussFaecher.class))) final GEAbschlussFaecher faecher,
			@Context final HttpServletRequest request) {
		final ServiceAbschlussMSA msa = new ServiceAbschlussMSA();
		final AbschlussErgebnis daten = msa.handle(faecher);
		if (daten == null)
			return new ApiOperationException(Status.BAD_REQUEST).getResponse();
		daten.log = msa.getLog().getStrings();
		return Response.status(Status.OK).type(MediaType.APPLICATION_JSON).entity(daten).build();
	}


	/**
	 * Die OpenAPI-Methode für die Prüfung auf den MSA_Q.
	 *
	 * @param faecher       zu übergebende Fächerdaten für die Prüfung auf MSA_Q
	 * @param request       die Informationen zur HTTP-Anfrage
	 *
	 * @return              das Ergebis der Prüfung auf MSA_Q
	 */
	@POST
	@Path("/msaq")
	@Operation(summary = "Führt eine Prüfung auf die Berechtigung zum Besuch der gymnasialen Oberstufe im Rahmen eines Mittleren "
			+ "Schulabschluss nach der Klasse 10 an einer Gesamtschule durch.",
			description = "Prüft anhand der übergeben Fächerdaten, ob die Berechtigung zum Besuch der gymnasialen Oberstufe im Rahmen eines Mittlerer "
					+ "Schulabschlusses nach der Klasse 10 an einer Gesamtschule erreicht wird oder nicht.")
	@ApiResponse(responseCode = "200", description = "Das Ergebnis der Abschlussberechnung, ggf. mit Nachprüfungsmöglichkeiten",
			content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = AbschlussErgebnis.class)))
	public Response getGesamtschuleAbschlussMSAQ(
			@RequestBody(description = "Die Fächerdaten für die Prüfung der Berechtigung", required = true,
					content = @Content(mediaType = MediaType.APPLICATION_JSON,
							schema = @Schema(implementation = GEAbschlussFaecher.class))) final GEAbschlussFaecher faecher,
			@Context final HttpServletRequest request) {
		final ServiceBerechtigungMSAQ msaq = new ServiceBerechtigungMSAQ();
		final AbschlussErgebnis daten = msaq.handle(faecher);
		if (daten == null)
			return new ApiOperationException(Status.BAD_REQUEST).getResponse();
		daten.log = msaq.getLog().getStrings();
		return Response.status(Status.OK).type(MediaType.APPLICATION_JSON).entity(daten).build();
	}


	/**
	 * Die OpenAPI-Methode für die Prüfung auf eine Abschlussprognose für die Gesamtschule.
	 *
	 * @param faecher       zu übergebende Fächerdaten für die Prüfung auf eine Abschlussprognose für die Gesamtschule
	 * @param request       die Informationen zur HTTP-Anfrage
	 *
	 * @return              das Ergebis der Prüfung der Abschlussprognose für die Gesamtschule
	 */
	@POST
	@Path("/prognose")
	@Operation(summary = "Führt eine Abschlussprognose für die Gesamtschule aus.",
			description = "Führt anhand der übergeben Fächerdaten eine Abschlussprognose für den Gesamtschulabschluss nach Klasse 9 bzw. Klasse 10 durch."
					+ "Wird der Jahrgang 10 angegeben, so findet keine Prüfung auf den HA9 statt.")
	@ApiResponse(responseCode = "200", description = "Das Ergebnis der Prognoseberechnung, ggf. mit Nachprüfungsmöglichkeiten",
			content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = AbschlussErgebnis.class)))
	public Response getGesamtschuleAbschlussPrognose(
			@RequestBody(description = "Der Jahrgang und die Fächerdaten für die Prognose", required = true,
					content = @Content(mediaType = MediaType.APPLICATION_JSON,
							schema = @Schema(implementation = GEAbschlussFaecher.class))) final GEAbschlussFaecher faecher,
			@Context final HttpServletRequest request) {
		final ServicePrognose prognose = new ServicePrognose();
		final AbschlussErgebnis daten = prognose.handle(faecher);
		if (daten == null)
			return new ApiOperationException(Status.BAD_REQUEST).getResponse();
		daten.log = prognose.getLog().getStrings();
		return Response.status(Status.OK).type(MediaType.APPLICATION_JSON).entity(daten).build();
	}

}