![JAR search and dependency download from the Maven repository](/logo.png)
de.svws_nrw.api.server.APIStundenplan 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
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
package de.svws_nrw.api.server;
import java.io.InputStream;
import de.svws_nrw.core.data.stundenplan.Stundenplan;
import de.svws_nrw.core.data.stundenplan.StundenplanAufsichtsbereich;
import de.svws_nrw.core.data.stundenplan.StundenplanKalenderwochenzuordnung;
import de.svws_nrw.core.data.stundenplan.StundenplanKomplett;
import de.svws_nrw.core.data.stundenplan.StundenplanLehrer;
import de.svws_nrw.core.data.stundenplan.StundenplanListeEintrag;
import de.svws_nrw.core.data.stundenplan.StundenplanPausenaufsicht;
import de.svws_nrw.core.data.stundenplan.StundenplanPausenaufsichtBereich;
import de.svws_nrw.core.data.stundenplan.StundenplanPausenaufsichtBereichUpdate;
import de.svws_nrw.core.data.stundenplan.StundenplanPausenzeit;
import de.svws_nrw.core.data.stundenplan.StundenplanRaum;
import de.svws_nrw.core.data.stundenplan.StundenplanSchiene;
import de.svws_nrw.core.data.stundenplan.StundenplanUnterricht;
import de.svws_nrw.core.data.stundenplan.StundenplanUnterrichtsverteilung;
import de.svws_nrw.core.data.stundenplan.StundenplanZeitraster;
import de.svws_nrw.core.types.ServerMode;
import de.svws_nrw.core.types.benutzer.BenutzerKompetenz;
import de.svws_nrw.data.JSONMapper;
import de.svws_nrw.data.benutzer.DBBenutzerUtils;
import de.svws_nrw.data.stundenplan.DataKlasseStundenplan;
import de.svws_nrw.data.stundenplan.DataLehrerStundenplan;
import de.svws_nrw.data.stundenplan.DataSchuelerStundenplan;
import de.svws_nrw.data.stundenplan.DataStundenplan;
import de.svws_nrw.data.stundenplan.DataStundenplanAufsichtsbereiche;
import de.svws_nrw.data.stundenplan.DataStundenplanKalenderwochenzuordnung;
import de.svws_nrw.data.stundenplan.DataStundenplanLehrer;
import de.svws_nrw.data.stundenplan.DataStundenplanListe;
import de.svws_nrw.data.stundenplan.DataStundenplanPausenaufsichten;
import de.svws_nrw.data.stundenplan.DataStundenplanPausenaufsichtenBereich;
import de.svws_nrw.data.stundenplan.DataStundenplanPausenzeiten;
import de.svws_nrw.data.stundenplan.DataStundenplanRaeume;
import de.svws_nrw.data.stundenplan.DataStundenplanSchienen;
import de.svws_nrw.data.stundenplan.DataStundenplanUnterricht;
import de.svws_nrw.data.stundenplan.DataStundenplanUnterrichtsverteilung;
import de.svws_nrw.data.stundenplan.DataStundenplanZeitraster;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.ArraySchema;
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;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.validation.constraints.NotNull;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.DELETE;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.PATCH;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.Context;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
/**
* Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die grundlegenden Stundenplandaten aus der SVWS-Datenbank.
* Ein Zugriff erfolgt über den Pfad https://{Hostname}/db/{schema}/stundenplan/...
*/
@Path("/db/{schema}/stundenplan")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Tag(name = "Server")
public class APIStundenplan {
/**
* Die OpenAPI-Methode für die Abfrage der Liste aller Stundenpläne.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Liste mit den Stundenplänen
*/
@GET
@Path("/liste")
@Operation(summary = "Gibt eine sortierte Übersicht aller Stundenpläne zurück.",
description = "Erstellt eine Liste der Stundenpläne. Die Stundenpläne sind anhand des Schuljahresabschnitt und der Gültigkeit sortiert."
+ "Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplanlisten besitzt.")
@ApiResponse(responseCode = "200", description = "Eine Liste der Stundenpläne",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanListeEintrag.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um Stundenplanlisten anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Stundenpläne gefunden",
content = @Content(mediaType = "text/plain", schema = @Schema(implementation = String.class)))
public Response getStundenplanliste(@PathParam("schema") final String schema, @Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanListe(conn).getList(),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für die Abfrage der Liste aller Stundenpläne eines Schuljahresabschnitts.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param abschnitt die ID des Schuljahresabschnitts
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Liste mit den Stundenplänen
*/
@GET
@Path("/liste/{abschnitt : \\d+}")
@Operation(summary = "Gibt eine sortierte Übersicht der Stundenpläne des angegebenen Schuljahresabschnitts zurück.",
description = "Erstellt eine Liste der Stundenpläne des angegebenen Schuljahresabschnitts. Die Stundenpläne sind anhand der Gültigkeit sortiert."
+ "Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplanlisten besitzt.")
@ApiResponse(responseCode = "200", description = "Eine Liste der Stundenpläne",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanListeEintrag.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um Stundenplanlisten anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Stundenpläne gefunden")
public Response getStundenplanlisteFuerAbschnitt(@PathParam("schema") final String schema, @PathParam("abschnitt") final long abschnitt,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanListe(conn).get(abschnitt),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für die Abfrage von grundlegenden Daten zu einem Stundenplan.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Stundenplans
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Daten für den angegebenen Stundenplan
*/
@GET
@Path("/{id : \\d+}")
@Operation(summary = "Gibt die grundlegenden Daten des Stundeplans mit der angegebenen ID zurück.",
description = "Gibt die grundlegenden Daten des Stundeplans mit der angegebenen ID zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Die Daten des Stundenplans",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = Stundenplan.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Stundenplandaten anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Stundenplandaten gefunden")
public Response getStundenplan(@PathParam("schema") final String schema, @PathParam("id") final long id, @Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplan(conn).get(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für das Patchen der Grunddaten eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param id die Datenbank-ID zur Identifikation des Stundenplans
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/{id : \\d+}")
@Operation(summary = "Passt die Stundenplandaten des Stundenplans mit der angebenen ID an.",
description = "Passt die Stundenplandaten des Stundenplans mit der angebenen ID an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag mit der angegebenen ID gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplan(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für die Stundenplandaten", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = Stundenplan.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplan(conn).patch(id, is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Erstellen eines neuen (leeren) Stundenplanes für den angegebenen Schuljahresabschnitt.
*
* @param schema das Datenbankschema
* @param idSchuljahresabschnitt die ID des Schuljahresabschnitts
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Stundenplan-Eintrag
*/
@POST
@Path("/create/{idSchuljahresabschnitt : \\d+}")
@Operation(summary = "Erstellt einen neuen (leeren) Stundenplan für den angegebenen Schuljahresabschnitt und gibt den zugehörigen Listeneintrag zurück.",
description = "Erstellt einen neuen (leeren) Stundenplan für den angegebenen Schuljahresabschnitt und gibt den zugehörigen Listeneintrag zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Der Stundenplan wurde erfolgreich hinzugefügt.",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanListeEintrag.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Der Schuljahresabschnitt wurde nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplan(@PathParam("schema") final String schema, @PathParam("idSchuljahresabschnitt") final long idSchuljahresabschnitt,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanListe(conn).addEmpty(idSchuljahresabschnitt),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status
*/
@DELETE
@Path("/{id : \\d+}")
@Operation(summary = "Entfernt einen Stundenplan.",
description = "Entfernt einen Stundenplan."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen des Stundenplans hat.")
@ApiResponse(responseCode = "204", description = "Der Stundenplan wurde erfolgreich entfernt.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu entfernen.")
@ApiResponse(responseCode = "404", description = "Der Stundenplan ist nicht vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplan(@PathParam("schema") final String schema, @PathParam("id") final long id, @Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanListe(conn).delete(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für die Abfrage des Zeitrasters zu einem Stundenplan.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Stundenplans
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Liste der Zeitraster-Einträge für den angegebenen Stundenplan
*/
@GET
@Path("/{id : \\d+}/zeitraster")
@Operation(summary = "Gibt die Einträge aus dem Zeitraster des angegebenen Stundeplans zurück.",
description = "Erstellt eine Liste der Einträge aus dem Zeitraster des angegebenen Stundeplans. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Eine Liste von Zeitraster-Einträgen",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanZeitraster.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um das Zeitraster anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Zeitraster-Einträge gefunden")
public Response getStundenplanZeitraster(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanZeitraster(conn, id).getList(),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für die Abfrage eines Zeitraster-Eintrags.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Zeitraster-Eintrags
* @param request die Informationen zur HTTP-Anfrage
*
* @return der Zeitraster-Eintrag
*/
@GET
@Path("/zeitraster/{id : \\d+}")
@Operation(summary = "Gibt den Zeitraster-Eintrag eines Stundeplans zurück.",
description = "Gibt den Zeitraster-Eintrag eines Stundeplans zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Zeitraster-Eintrag",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanZeitraster.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Kein Zeitraster-Eintrag eines Stundenplans gefunden")
public Response getStundenplanZeitrasterEintrag(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanZeitraster(conn, null).get(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für das Patchen eines Zeitraster-Eintrags eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param id die Datenbank-ID zur Identifikation des Zeitraster-Eintrags
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/zeitraster/{id : \\d+}")
@Operation(summary = "Passt den Zeitrastereintrag mit der angebenen ID an.",
description = "Passt den Zeitrastereintrag mit der angebenen ID an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag mit der angegebenen ID gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanZeitrasterEintrag(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für den Zeitrastereintrag", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanZeitraster.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanZeitraster(conn, null).patch(id, is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Patchen mehrerer Zeitraster-Einträge. Die IDs in dem Patch
* müssen vorhanden sein, damit die zu patchenden Daten in der DB gefunden werden können.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/zeitraster/patch/multiple")
@Operation(summary = "Passt die Zeitrastereinträge an.",
description = "Passt die Zeitrastereinträge an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag für mindestens eine der IDs der Daten gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanZeitrasterEintraege(@PathParam("schema") final String schema,
@RequestBody(description = "Der Patch für den Zeitrastereintrag", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanZeitraster.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanZeitraster(conn, null).patchMultiple(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen eines neuen Zeitrastereintrags zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten des Zeitrastereintrags
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem neuen Zeitrastereintrag
*/
@POST
@Path("/{id : \\d+}/zeitraster/create")
@Operation(summary = "Erstellt einen neuen Zeitrastereintrag für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt einen neuen Zeitrastereintrag für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Der Zeitrastereintrag wurde erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = StundenplanZeitraster.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Zeitrastereintrag für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanZeitrasterEintrag(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten des zu erstellenden Zeitrastereintrags ohne ID, welche automatisch generiert wird", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanZeitraster.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanZeitraster(conn, id).add(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Zeitrastereinträge zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten der Zeitrastereinträge
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit der Liste der neuen Zeitrastereinträge
*/
@POST
@Path("/{id : \\d+}/zeitraster/create/multiple")
@Operation(summary = "Erstellt mehrere neue Zeitrastereinträge für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt mehrere neue Zeitrastereinträge für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Zeitrastereinträge wurden erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, array = @ArraySchema(schema = @Schema(implementation = StundenplanZeitraster.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um Zeitrastereinträge für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanZeitrasterEintraege(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten der zu erstellenden Zeitrastereinträge ohne IDs, welche automatisch generiert werden", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanZeitraster.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanZeitraster(conn, id).addMultiple(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen des Zeitrastereintrags eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Zeitrastereintrags
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. dem gelöschten Zeitrastereintrag
*/
@DELETE
@Path("/zeitraster/{id : \\d+}")
@Operation(summary = "Entfernt einen Zeitrastereintrag eines Stundenplans.",
description = "Entfernt einen Zeitrastereintrag eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Der Zeitrastereintrag wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanZeitraster.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Kein Zeitrastereintrag vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanZeitrasterEintrag(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanZeitraster(conn, null).delete(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen mehrerer Zeitrastereinträge eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is die IDs der Zeitrastereinträge
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. den gelöschten Zeitrastereinträgen
*/
@DELETE
@Path("/{id : \\d+}/zeitraster/delete/multiple")
@Operation(summary = "Entfernt mehrere Zeitrastereinträge eines Stundenplans.",
description = "Entfernt mehrere Zeitrastereinträge eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Zeitrastereinträge wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanZeitraster.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Kein Zeitrastereintrag vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanZeitrasterEintraege(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die IDs der zu löschenden Zeitrastereinträge", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = Long.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanZeitraster(conn, id).deleteMultiple(JSONMapper.toListOfLong(is)),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für die Abfrage eines Raumes eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Raumes
* @param request die Informationen zur HTTP-Anfrage
*
* @return der Raum eines Stundenplans
*/
@GET
@Path("/raeume/{id : \\d+}")
@Operation(summary = "Gibt den Raum eines Stundenplans zurück.",
description = "Gibt den Raum eines Stundenplans zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Raum",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanRaum.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Kein Raum eines Stundenplans gefunden")
public Response getStundenplanRaum(@PathParam("schema") final String schema, @PathParam("id") final long id, @Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanRaeume(conn, null).get(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für das Patchen eines Raumes eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param id die Datenbank-ID zur Identifikation des Raumes
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/raeume/{id : \\d+}")
@Operation(summary = "Passt den Raum mit der angebenen ID an.",
description = "Passt den Raum mit der angebenen ID an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag mit der angegebenen ID gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanRaum(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für den Raum", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = StundenplanRaum.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanRaeume(conn, null).patch(id, is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen eines neuen Raumes zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten des Raums
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem neuen Raum
*/
@POST
@Path("/{id : \\d+}/raeume/create")
@Operation(summary = "Erstellt einen neuen Raum für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt einen neuen Raum für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Der Raum wurde erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = StundenplanRaum.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Raum für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanRaum(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten des zu erstellenden Raumes ohne ID, welche automatisch generiert wird", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = StundenplanRaum.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanRaeume(conn, id).add(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Räume zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten der Räume
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit der Liste der neuen Räume
*/
@POST
@Path("/{id : \\d+}/raeume/create/multiple")
@Operation(summary = "Erstellt mehrere neue Räume für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt mehrere neue Räume für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Räume wurden erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, array = @ArraySchema(schema = @Schema(implementation = StundenplanRaum.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um Räume für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanRaeume(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten der zu erstellenden Räume ohne IDs, welche automatisch generiert werden", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanRaum.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanRaeume(conn, id).addMultiple(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen des Raums eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Raums
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. dem gelöschten Raum
*/
@DELETE
@Path("/raeume/{id : \\d+}")
@Operation(summary = "Entfernt einen Raum eines Stundenplans.",
description = "Entfernt einen Raum eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Der Raum wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanRaum.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Kein Raum vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanRaum(@PathParam("schema") final String schema, @PathParam("id") final long id, @Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanRaeume(conn, null).delete(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen mehrerer Räume eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is die IDs der Räume
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. den gelöschten Räumen
*/
@DELETE
@Path("/{id : \\d+}/raeume/delete/multiple")
@Operation(summary = "Entfernt mehrere Räume eines Stundenplans.",
description = "Entfernt mehrere Räume eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Räume wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanRaum.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Raum nicht vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanRaeume(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die IDs der zu löschenden Räume", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = Long.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanRaeume(conn, id).deleteMultiple(JSONMapper.toListOfLong(is)),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für die Abfrage eines Aufsichtsbereichs eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Aufsichtsbereichs
* @param request die Informationen zur HTTP-Anfrage
*
* @return der Aufsichtsbereich eines Stundenplans
*/
@GET
@Path("/aufsichtsbereich/{id : \\d+}")
@Operation(summary = "Gibt den Aufsichtsbereich eines Stundenplans zurück.",
description = "Gibt den Aufsichtsbereich eines Stundenplans zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Raum",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanAufsichtsbereich.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Kein Aufsichtsbereich eines Stundenplans gefunden")
public Response getStundenplanAufsichtsbereich(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanAufsichtsbereiche(conn, null).get(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für das Patchen eines Aufsichtsbereichs eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param id die Datenbank-ID zur Identifikation des Aufsichtsbereichs
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/aufsichtsbereich/{id : \\d+}")
@Operation(summary = "Passt den Aufsichtsbereich mit der angebenen ID an.",
description = "Passt den Aufsichtsbereich mit der angebenen ID an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag mit der angegebenen ID gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanAufsichtsbereich(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für den Aufsichtsbereich", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanAufsichtsbereich.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanAufsichtsbereiche(conn, null).patch(id, is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen eines neuen Aufsichtsbereichs zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten des Aufsichtsbereichs
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem neuen Aufsichtsbereich
*/
@POST
@Path("/{id : \\d+}/aufsichtsbereiche/create")
@Operation(summary = "Erstellt einen neuen Aufsichtsbereich für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt einen neuen Aufsichtsbereich für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Der Aufsichtsbereich wurde erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = StundenplanAufsichtsbereich.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Raum für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanAufsichtsbereich(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten des zu erstellenden Aufsichtsbereichs ohne ID, welche automatisch generiert wird", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanAufsichtsbereich.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanAufsichtsbereiche(conn, id).add(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Aufsichtsbereiche zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten der Aufsichtsbereiche
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit der Liste der neuen Aufsichtsbereiche
*/
@POST
@Path("/{id : \\d+}/aufsichtsbereiche/create/multiple")
@Operation(summary = "Erstellt mehrere neue Aufsichtsbereiche für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt mehrere neue Aufsichtsbereiche für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Aufsichtsbereiche wurden erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanAufsichtsbereich.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um Aufsichtsbereiche für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanAufsichtsbereiche(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten der zu erstellenden Aufsichtsbereiche ohne IDs, welche automatisch generiert werden", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanAufsichtsbereich.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanAufsichtsbereiche(conn, id).addMultiple(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen des Aufsichtsbereichs eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Aufsichtsbereichs
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. dem gelöschten Aufsichtsbereich
*/
@DELETE
@Path("/aufsichtsbereiche/{id : \\d+}")
@Operation(summary = "Entfernt einen Aufsichtsbereich eines Stundenplans.",
description = "Entfernt einen Aufsichtsbereich eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Der Aufsichtsbereich wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanAufsichtsbereich.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Kein Aufsichtsbereich vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanAufsichtsbereich(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanAufsichtsbereiche(conn, null).delete(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen mehrerer Aufsichtsbereiche eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is die IDs der Aufsichtsbereiche
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. den gelöschten Aufsichtsbereichen
*/
@DELETE
@Path("/{id : \\d+}/aufsichtsbereiche/delete/multiple")
@Operation(summary = "Entfernt mehrere Aufsichtsbereiche eines Stundenplans.",
description = "Entfernt mehrere Aufsichtsbereiche eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Aufsichtsbereiche wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanAufsichtsbereich.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Aufsichtsbereich nicht vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanAufsichtsbereiche(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die IDs der zu löschenden Aufsichtsbereiche", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = Long.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanAufsichtsbereiche(conn, id).deleteMultiple(JSONMapper.toListOfLong(is)),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für die Abfrage einer Schiene eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID der Schiene
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Schiene eines Stundenplans
*/
@GET
@Path("/schienen/{id : \\d+}")
@Operation(summary = "Gibt die Schiene eines Stundeplans zurück.",
description = "Gibt die Schiene eines Stundeplans zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Die Schiene",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanSchiene.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Schiene eines Stundenplans gefunden")
public Response getStundenplanSchiene(@PathParam("schema") final String schema, @PathParam("id") final long id, @Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanSchienen(conn, null).get(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für das Patchen einer Schiene eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param id die Datenbank-ID zur Identifikation der Schiene
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/schienen/{id : \\d+}")
@Operation(summary = "Passt die Schiene mit der angebenen ID an.",
description = "Passt die Schiene mit der angebenen ID an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag mit der angegebenen ID gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanSchiene(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für die Schiene", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanSchiene.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanSchienen(conn, null).patch(id, is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für die Abfrage einer Pausenzeit eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID der Pausenzeit
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Pausenzeit eines Stundenplans
*/
@GET
@Path("/pausenzeiten/{id : \\d+}")
@Operation(summary = "Gibt die Pausenzeit eines Stundenplans zurück.",
description = "Gibt die Pausenzeit eines Stundenplans zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Die Pausenzeit",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanPausenzeit.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Pausenzeit eines Stundenplans gefunden")
public Response getStundenplanPausenzeit(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenzeiten(conn, null).getByIdAsResponse(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für das Patchen einer Pausenzeit eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param id die Datenbank-ID zur Identifikation der Pausenzeit
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/pausenzeiten/{id : \\d+}")
@Operation(summary = "Passt die Pausenzeit mit der angebenen ID an.",
description = "Passt die Pausenzeit mit der angebenen ID an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag mit der angegebenen ID gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanPausenzeit(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für die Pausenzeit", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanPausenzeit.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenzeiten(conn, null).patchAsResponse(id, is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen einer neuen Pausenzeit zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten der Pausenzeit
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit der neuen Pausenzeit
*/
@POST
@Path("/{id : \\d+}/pausenzeiten/create")
@Operation(summary = "Erstellt eine neue Pausenzeit für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt eine neue Pausenzeit für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Pausenzeit wurde erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = StundenplanPausenzeit.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um eine Pausenzeit für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanPausenzeit(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten der zu erstellenden Pausenzeit ohne ID, welche automatisch generiert wird", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanPausenzeit.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenzeiten(conn, id).addAsResponse(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Pausenzeiten zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten der Pausenzeiten
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit der Liste der neuen Pausenzeiten
*/
@POST
@Path("/{id : \\d+}/pausenzeiten/create/multiple")
@Operation(summary = "Erstellt mehrere neue Pausenzeiten für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt mehrere neue Pausenzeiten für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Pausenzeiten wurden erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, array = @ArraySchema(schema = @Schema(implementation = StundenplanPausenzeit.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um Pausenzeiten für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanPausenzeiten(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten der zu erstellenden Pausenzeiten ohne IDs, welche automatisch generiert werden", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanPausenzeit.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenzeiten(conn, id).addMultipleAsResponse(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen der Pausenzeit eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID der Pausenzeit
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. der gelöschten Pausenzeit
*/
@DELETE
@Path("/pausenzeiten/{id : \\d+}")
@Operation(summary = "Entfernt eine Pausenzeit eines Stundenplans.",
description = "Entfernt eine Pausenzeit eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Pausenzeit wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanPausenzeit.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Keine Pausenzeit vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanPausenzeit(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenzeiten(conn, null).deleteAsResponse(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen mehrerer Pausenzeiten eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is die IDs der Pausenzeiten
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. den gelöschten Pausenzeiten
*/
@DELETE
@Path("/{id : \\d+}/pausenzeiten/delete/multiple")
@Operation(summary = "Entfernt mehrere Pausenzeiten eines Stundenplans.",
description = "Entfernt mehrere Pausenzeiten eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Pausenzeiten wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanPausenzeit.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Pausenzeit nicht vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanPausenzeiten(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die IDs der zu löschenden Pausenzeiten", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = Long.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenzeiten(conn, id).deleteMultipleAsResponse(JSONMapper.toListOfLong(is)),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für die Abfrage von Kalenderwochen-Zuordnungen eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID der Kalenderwochen-Zuordnung
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Kalenderwochen-Zuordnung eines Stundenplans
*/
@GET
@Path("/kalenderwochen/{id : \\d+}")
@Operation(summary = "Gibt die Kalenderwochen-Zuordnung eines Stundeplans zurück.",
description = "Gibt die Kalenderwochen-Zuordnung eines Stundeplans zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Die Kalenderwochen-Zuordnung",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanKalenderwochenzuordnung.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Kalenderwochen-Zuordnung eines Stundenplans gefunden")
public Response getStundenplanKalenderwochenzuordnung(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanKalenderwochenzuordnung(conn, null).getByIdAsResponse(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für das Patchen einer Kalenderwochen-Zuordnung eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param id die Datenbank-ID zur Identifikation der Kalenderwochen-Zuordnung
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/kalenderwochen/{id : \\d+}")
@Operation(summary = "Passt die Kalenderwochen-Zuordnung mit der angebenen ID an.",
description = "Passt die Kalenderwochen-Zuordnung mit der angebenen ID an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag mit der angegebenen ID gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanKalenderwochenzuordnung(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für die Kalenderwochen-Zuordnung", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanKalenderwochenzuordnung.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanKalenderwochenzuordnung(conn, null).patchAsResponse(id, is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Patchen mehrerer Kalenderwochen-Zuordnungen. Die IDs in dem Patch
* müssen vorhanden sein, damit die zu patchenden Daten in der DB gefunden werden können.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param id die ID des Stundenplans
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/{id : \\d+}/kalenderwochen/patch/multiple")
@Operation(summary = "Passt die Kalenderwochen-Zuordnungen eines Stundenplans an.",
description = "Passt die Kalenderwochen-Zuordnungen eines Stundenplans an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag für mindestens eine der IDs der Daten gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanKalenderwochenzuordnungen(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für die Kalenderwochenzuordnungen", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanKalenderwochenzuordnung.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanKalenderwochenzuordnung(conn, id).patchMultipleAsResponse(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen einer neuen Kalenderwochenzuordnung zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten der Kalenderwochenzuordnung
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit der neuen Kalenderwochenzuordnung
*/
@POST
@Path("/{id : \\d+}/kalenderwochen/create")
@Operation(summary = "Erstellt eine neue Kalenderwochenzuordnung für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt eine neue Kalenderwochenzuordnung für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Kalenderwochenzuordnung wurde erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = StundenplanKalenderwochenzuordnung.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um eine Kalenderwochenzuordnung für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanKalenderwochenzuordnung(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten der zu erstellenden Kalenderwochenzuordnung ohne ID, welche automatisch generiert wird", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanKalenderwochenzuordnung.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanKalenderwochenzuordnung(conn, id).addAsResponse(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Kalenderwochenzuordnungen zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten der Kalenderwochenzuordnungen
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit der Liste der neuen Kalenderwochenzuordnungen
*/
@POST
@Path("/{id : \\d+}/kalenderwochen/create/multiple")
@Operation(summary = "Erstellt mehrere neue Kalenderwochenzuordnungen für den angegebenen Stundenplan und gibt die zugehörigen Objekte zurück.",
description = "Erstellt mehrere neue Kalenderwochenzuordnungen für den angegebenen Stundenplan und gibt die zugehörigen Objekte zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Kalenderwochenzuordnungen wurden erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanKalenderwochenzuordnung.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um Kalenderwochenzuordnungen für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanKalenderwochenzuordnungen(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten der zu erstellenden Kalenderwochenzuordnungen ohne IDs, welche automatisch generiert werden", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanKalenderwochenzuordnung.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanKalenderwochenzuordnung(conn, id).addMultipleAsResponse(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen der Kalenderwochenzuordnung eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID der Kalenderwochenzuordnung
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. der gelöschten Kalenderwochenzuordnung
*/
@DELETE
@Path("/kalenderwochen/{id : \\d+}")
@Operation(summary = "Entfernt eine Kalenderwochenzuordnung eines Stundenplans.",
description = "Entfernt eine Kalenderwochenzuordnung eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Kalenderwochenzuordnung wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanKalenderwochenzuordnung.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Keine Kalenderwochenzuordnung vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanKalenderwochenzuordnung(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanKalenderwochenzuordnung(conn, null).deleteAsResponse(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen mehrerer Kalenderwochenzuordnungen eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is die IDs der Kalenderwochenzuordnungen
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. den gelöschten Kalenderwochenzuordnungen
*/
@DELETE
@Path("/{id : \\d+}/kalenderwochen/delete/multiple")
@Operation(summary = "Entfernt mehrere Kalenderwochenzuordnungen eines Stundenplans.",
description = "Entfernt mehrere Kalenderwochenzuordnungen eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Kalenderwochenzuordnungen wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json",
array = @ArraySchema(schema = @Schema(implementation = StundenplanKalenderwochenzuordnung.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Mindestens eine Kalenderwochenzuordnung ist nicht vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanKalenderwochenzuordnungen(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die IDs der zu löschenden Kalenderwochenzuordnungen", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = Long.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanKalenderwochenzuordnung(conn, id).deleteMultipleAsResponse(JSONMapper.toListOfLong(is)),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für die Abfrage aller Pausenaufsichten zu einem Stundenplan.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Stundenplans
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Pausenaufsichten für den angegebenen Stundenplan
*/
@GET
@Path("/{id : \\d+}/pausenaufsichten")
@Operation(summary = "Gibt die Pausenaufsichten des Stundeplans mit der angegebenen ID zurück.",
description = "Gibt die Pausenaufsichten des Stundeplans mit der angegebenen ID zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Die Pausenaufsichten des Stundenplans",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanPausenaufsicht.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Stundenplandaten anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Stundenplandaten gefunden")
public Response getStundenplanPausenaufsichten(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenaufsichten(conn, id).getList(),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für die Abfrage einer Pausenaufsicht eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID der Pausenaufsicht
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Pausenaufsicht
*/
@GET
@Path("/pausenaufsicht/{id : \\d+}")
@Operation(summary = "Gibt eine Pausenaufsicht eines Stundeplans zurück.",
description = "Gibt eine Pausenaufsicht eines Stundeplans zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Die Pausenaufsicht",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanPausenaufsicht.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Pausenaufsicht eines Stundenplans gefunden")
public Response getStundenplanPausenaufsicht(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenaufsichten(conn, null).get(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für das Patchen einer Pausenaufsicht eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param sid die Datenbank-ID des Stundenplans
* @param id die Datenbank-ID zur Identifikation der Pausenaufsicht
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/{idStundenplan : \\d+}/pausenaufsicht/{id : \\d+}")
@Operation(summary = "Passt die Pausenaufsicht mit der angebenen ID an.",
description = "Passt die Pausenaufsicht mit der angebenen ID an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag mit der angegebenen ID gefunden")
@ApiResponse(responseCode = "409",
description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanPausenaufsicht(@PathParam("schema") final String schema,
@PathParam("idStundenplan") final long sid, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für die Kalenderwochen-Zuordnung", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanPausenaufsicht.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenaufsichten(conn, sid).patch(id, is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen einer neuen Pausenaufsicht zu einer Pausenzeit bei
* einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten der Pausenaufsicht
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit der neuen Pausenaufsicht
*/
@POST
@Path("/{id : \\d+}/pausenaufsicht/create")
@Operation(summary = "Erstellt eine neue Pausenaufsicht für die angebene Pausenzeit eines Stundenplans und gibt das zugehörige Objekt zurück.",
description = "Erstellt eine neue Pausenaufsicht für die angebene Pausenzeit eines Stundenplans und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Pausenaufsicht wurde erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = StundenplanPausenaufsicht.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um eine Pausenaufsicht für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanPausenaufsicht(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten der zu erstellenden Pausenaufsicht ohne ID, welche automatisch generiert wird", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanPausenaufsicht.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenaufsichten(conn, id).add(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Pausenaufsichten zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is der Input-Stream mit den Daten der Pausenaufsichten
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit den neuen Pausenaufsichten
*/
@POST
@Path("/{id : \\d+}/pausenaufsicht/create/multiple")
@Operation(summary = "Erstellt neue Pausenaufsichten für einen Stundenplan und gibt die zugehörigen Objekte zurück.",
description = "Erstellt neue Pausenaufsichten für einen Stundenplan und gibt die zugehörigen Objekte zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Pausenaufsichten wurden erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanPausenaufsicht.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um Pausenaufsichten für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanPausenaufsichten(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Daten der zu erstellenden Pausenaufsichten ohne IDs, welche automatisch generiert wird", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanPausenaufsicht.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenaufsichten(conn, id).addMultiple(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen einer Pausenaufsicht eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID der Pausenaufsicht
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. der gelöschten Pausenaufsicht
*/
@DELETE
@Path("/pausenaufsicht/{id : \\d+}")
@Operation(summary = "Entfernt eine Pausenaufsicht eines Stundenplans.",
description = "Entfernt eine Pausenaufsicht eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Pausenaufsicht wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanPausenaufsicht.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Keine Pausenaufsicht vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanPausenaufsicht(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenaufsichten(conn, null).delete(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen mehrerer Pausenaufsichten eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is die IDs der Pausenaufsichten
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. den gelöschten Pausenaufsichten
*/
@DELETE
@Path("/{id : \\d+}/pausenaufsicht/delete/multiple")
@Operation(summary = "Entfernt mehrere Pausenaufsichten eines Stundenplans.",
description = "Entfernt mehrere Pausenaufsichten eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Pausenaufsichten wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanPausenaufsicht.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Pausenaufsicht nicht vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanPausenaufsichten(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die IDs der zu löschenden Pausenaufsichten", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = Long.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenaufsichten(conn, id).deleteMultiple(JSONMapper.toListOfLong(is)),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen und Hinzufügen mehrerer Zuordnungen von Pausenaufsichten zu
* Aufsichtsbereichen ggf. in Abhängigkeit von einem Wochentyp.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Stundenplans
* @param update die Information zu den Änderungen der Zuordnungen
* @param request die Informationen zur HTTP-Anfrage
*
* @return eine Response mit dem Status-Code
*/
@POST
@Path("/{id : \\d+}/pausenaufsichtenbereiche/update")
@Operation(summary = "Entfernt und fügt mehrere Zuordungen von Pausenaufsichten zu Aufsichtsbereichen ggf. in Abhängigkeit von einem Wochentyp hinzu.",
description = "Entfernt und fügt mehrere Zuordungen von Pausenaufsichten zu Aufsichtsbereichen ggf. in Abhängigkeit von einem Wochentyp hinzu. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen und Hinzufügen besitzt.")
@ApiResponse(responseCode = "200",
description = "Die Zuordnungen wurden erfolgreich gelöscht bzw. hinzugefügt. Das Ergebnis beinhaltet die erstellten Zuordnungen",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanPausenaufsichtBereich.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Zuordnungen zu löschen oder hinzufügen.")
@ApiResponse(responseCode = "404", description = "Ein Wert für das Erstellen der Zuordnungen wurde nicht gefunden.")
public Response updateStundenplanPausenaufsichtenBereiche(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die Informationen zu den Zuordnungen", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(
implementation = StundenplanPausenaufsichtBereichUpdate.class))) final @NotNull StundenplanPausenaufsichtBereichUpdate update,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanPausenaufsichtenBereich(conn, id).update(update),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für die Abfrage aller Unterrichte zu einem Stundenplan.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Stundenplans
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Unterrichte für den angegebenen Stundenplan
*/
@GET
@Path("/{id : \\d+}/unterrichte")
@Operation(summary = "Gibt die Unterrichte des Stundeplans mit der angegebenen ID zurück.",
description = "Gibt die Unterrichte des Stundeplans mit der angegebenen ID zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Die Unterrichte des Stundenplans",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanUnterricht.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Stundenplandaten anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Stundenplandaten gefunden")
public Response getStundenplanUnterrichte(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanUnterricht(conn, id).getList(),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für die Abfrage eines Unterrichts eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Unterrichts
* @param request die Informationen zur HTTP-Anfrage
*
* @return der Unterricht
*/
@GET
@Path("/unterricht/{id : \\d+}")
@Operation(summary = "Gibt einen Unterricht eines Stundeplans zurück.",
description = "Gibt einen Unterricht eines Stundeplans zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Unterricht",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanUnterricht.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Kein Unterricht eines Stundenplans gefunden")
public Response getStundenplanUnterricht(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanUnterricht(conn, null).get(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für das Patchen eines Unterrichts eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param id die Datenbank-ID zur Identifikation des Unterrichts
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/unterricht/{id : \\d+}")
@Operation(summary = "Passt den Unterricht mit der angebenen ID an.",
description = "Passt den Unterricht mit der angebenen ID an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag mit der angegebenen ID gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanUnterricht(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Der Patch für den Unterricht", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanUnterricht.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanUnterricht(conn, null).patch(id, is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Patchen mehrerer Unterrichte. Die IDs in dem Patch
* müssen vorhanden sein, damit die zu patchenden Daten in der DB gefunden werden können.
*
* @param schema das Datenbankschema, auf welches der Patch ausgeführt werden soll
* @param is der InputStream, mit dem JSON-Patch-Objekt nach RFC 7386
* @param request die Informationen zur HTTP-Anfrage
*
* @return das Ergebnis der Patch-Operation
*/
@PATCH
@Path("/unterricht/patch/multiple")
@Operation(summary = "Passt die Unterrichte an.",
description = "Passt die Unterrichte an. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Patch wurde erfolgreich integriert.")
@ApiResponse(responseCode = "400", description = "Der Patch ist fehlerhaft aufgebaut.")
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern.")
@ApiResponse(responseCode = "404", description = "Kein Eintrag für mindestens eine der IDs der Daten gefunden")
@ApiResponse(responseCode = "409", description = "Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde"
+ " (z.B. eine negative ID)")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response patchStundenplanUnterrichte(@PathParam("schema") final String schema,
@RequestBody(description = "Der Patch für die Unterrichte", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanUnterricht.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanUnterricht(conn, null).patchMultiple(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen eines neuen Unterrichts zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param is der Input-Stream mit den Daten des Unterrichts
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem neuen Unterricht
*/
@POST
@Path("/unterricht/create")
@Operation(summary = "Erstellt einen neue Unterricht für einen Stundenplan und gibt das zugehörige Objekt zurück.",
description = "Erstellt einen neue Unterricht für einen Stundenplan und gibt das zugehörige Objekt zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Der Unterricht wurde erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, schema = @Schema(implementation = StundenplanUnterricht.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Unterricht für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanUnterricht(@PathParam("schema") final String schema,
@RequestBody(description = "Die Daten des zu erstellenden Unterrichts ohne ID, welche automatisch generiert wird", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = StundenplanUnterricht.class))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanUnterricht(conn, null).add(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Hinzufügen mehrerer neuer Unterrichte zu einem bestehendem Stundenplan.
*
* @param schema das Datenbankschema
* @param is der Input-Stream mit den Daten der Unterrichte
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit den neuen Unterrichten
*/
@POST
@Path("/unterricht/create/multiple")
@Operation(summary = "Erstellt neue Unterrichte für einen Stundenplan und gibt die zugehörigen Objekte zurück.",
description = "Erstellt neue Unterrichte für einen Stundenplan und gibt die zugehörigen Objekte zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt.")
@ApiResponse(responseCode = "201", description = "Die Unterrichte wurden erfolgreich hinzugefügt.",
content = @Content(mediaType = MediaType.APPLICATION_JSON, array = @ArraySchema(schema = @Schema(implementation = StundenplanUnterricht.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um Unterrichte für einen Stundenplan anzulegen.")
@ApiResponse(responseCode = "404", description = "Die Stundenplandaten wurden nicht gefunden")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response addStundenplanUnterrichte(@PathParam("schema") final String schema,
@RequestBody(description = "Die Daten der zu erstellenden Unterrichte ohne IDs, welche automatisch generiert wird", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = StundenplanUnterricht.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanUnterricht(conn, null).addMultiple(is),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen eines Unterrichts eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Unterrichts
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. dem gelöschten Unterricht
*/
@DELETE
@Path("/unterricht/{id : \\d+}")
@Operation(summary = "Entfernt einen Unterricht eines Stundenplans.",
description = "Entfernt einen Unterricht eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Der Unterricht wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanUnterricht.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Kein Unterricht mit der ID vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanUnterricht(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanUnterricht(conn, null).delete(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für das Entfernen mehrerer Unterrichte eines Stundenplans.
*
* @param schema das Datenbankschema
* @param id die ID des Stundenplans
* @param is die IDs der Unterrichte
* @param request die Informationen zur HTTP-Anfrage
*
* @return die HTTP-Antwort mit dem Status und ggf. den gelöschten Unterrichte
*/
@DELETE
@Path("/{id : \\d+}/unterricht/delete/multiple")
@Operation(summary = "Entfernt mehrere Unterrichte eines Stundenplans.",
description = "Entfernt mehrere Unterrichte eines Stundenplans."
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat.")
@ApiResponse(responseCode = "200", description = "Die Unterrichte wurde erfolgreich entfernt.",
content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = StundenplanUnterricht.class))))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten.")
@ApiResponse(responseCode = "404", description = "Unterricht nicht vorhanden")
@ApiResponse(responseCode = "409", description = "Die übergebenen Daten sind fehlerhaft")
@ApiResponse(responseCode = "500", description = "Unspezifizierter Fehler (z.B. beim Datenbankzugriff)")
public Response deleteStundenplanUnterrichte(@PathParam("schema") final String schema, @PathParam("id") final long id,
@RequestBody(description = "Die IDs der zu löschenden Unterrichte", required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON,
array = @ArraySchema(schema = @Schema(implementation = Long.class)))) final InputStream is,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanUnterricht(conn, id).deleteMultiple(JSONMapper.toListOfLong(is)),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_AENDERN);
}
/**
* Die OpenAPI-Methode für die Abfrage von Daten zu Unterrichtsverteilung zu einem Stundenplan.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Stundenplans
* @param request die Informationen zur HTTP-Anfrage
*
* @return die Daten zur Unterrichtsverteilung für den angegebenen Stundenplan
*/
@GET
@Path("/{id : \\d+}/unterrichtsverteilung")
@Operation(summary = "Gibt die Daten zur Unterrichtsverteilung des Stundenplans mit der angegebenen ID zurück.",
description = "Gibt die Daten zur Unterrichtsverteilung des Stundenplans mit der angegebenen ID zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Die Daten zur Unterrichtsverteilung des Stundenplans",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanUnterrichtsverteilung.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um die Stundenplandaten anzusehen.")
@ApiResponse(responseCode = "404", description = "Keine Stundenplandaten gefunden")
public Response getStundenplanUnterrichtsverteilung(@PathParam("schema") final String schema, @PathParam("id") final long id,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanUnterrichtsverteilung(conn).get(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für die Abfrage eines Lehrers eines Stundenplans.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param idStundenplan die ID des Stundenplans
* @param id die ID des Lehrers
* @param request die Informationen zur HTTP-Anfrage
*
* @return der Lehrer
*/
@GET
@Path("{idStundenplan : \\d+}/lehrer/{id : \\d+}")
@Operation(summary = "Gibt den Lehrer eines Stundenplans zurück.",
description = "Gibt den Lehrer eines Stundenplans zurück. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Lehrer",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanLehrer.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Kein Raum eines Stundenplans gefunden")
public Response getStundenplanLehrer(@PathParam("schema") final String schema, @PathParam("idStundenplan") final long idStundenplan,
@PathParam("id") final long id, @Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataStundenplanLehrer(conn, idStundenplan).get(id),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für die Abfrage des Stundenplans eines Schülers.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Stundenplans
* @param schuelerID die ID des Schülers
* @param request die Informationen zur HTTP-Anfrage
*
* @return der Stundenplan des Schülers
*/
@GET
@Path("/plaene/{id : \\d+}/schueler/{schueler_id : \\d+}")
@Operation(summary = "Gibt den Stundeplan des Schülers zurück.",
description = "Erstellt den angebebenen Stundeplan in Bezug auf den angegebenen Schüler. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Schüler-Stundenplan",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanKomplett.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Keinen Stundenplan gefunden")
public Response getSchuelerStundenplan(@PathParam("schema") final String schema, @PathParam("id") final long id,
@PathParam("schueler_id") final long schuelerID, @Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataSchuelerStundenplan(conn, id).get(schuelerID),
request, ServerMode.STABLE,
BenutzerKompetenz.SCHUELER_INDIVIDUALDATEN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für die Abfrage des Stundenplans eines Lehrers.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Stundenplans
* @param lehrerID die ID des Lehrers
* @param request die Informationen zur HTTP-Anfrage
*
* @return der Stundenplan des Lehrers
*/
@GET
@Path("/plaene/{id : \\d+}/lehrer/{lehrer_id : \\d+}")
@Operation(summary = "Gibt den Stundeplan des Lehrers zurück.",
description = "Erstellt den angebebenen Stundeplan in Bezug auf den angegebenen Lehrer. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Lehrer-Stundenplan",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanKomplett.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Keinen Stundenplan gefunden")
public Response getLehrerStundenplan(@PathParam("schema") final String schema, @PathParam("id") final long id, @PathParam("lehrer_id") final long lehrerID,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataLehrerStundenplan(conn, id).get(lehrerID),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
/**
* Die OpenAPI-Methode für die Abfrage des Stundenplans einer Klasse.
*
* @param schema das Datenbankschema, auf welches die Abfrage ausgeführt werden soll
* @param id die ID des Stundenplans
* @param klasseID die ID der Klasse
* @param request die Informationen zur HTTP-Anfrage
*
* @return der Stundenplan der Klasse
*/
@GET
@Path("/plaene/{id : \\d+}/klasse/{klasse_id : \\d+}")
@Operation(summary = "Gibt den Stundeplan der Klasse zurück.",
description = "Erstellt den angebebenen Stundeplan in Bezug auf die angegebene Klasse. "
+ "Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt.")
@ApiResponse(responseCode = "200", description = "Der Klassen-Stundenplan",
content = @Content(mediaType = "application/json", schema = @Schema(implementation = StundenplanKomplett.class)))
@ApiResponse(responseCode = "403", description = "Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen.")
@ApiResponse(responseCode = "404", description = "Keinen Stundenplan gefunden")
public Response getKlassenStundenplan(@PathParam("schema") final String schema, @PathParam("id") final long id, @PathParam("klasse_id") final long klasseID,
@Context final HttpServletRequest request) {
return DBBenutzerUtils.runWithTransaction(conn -> new DataKlasseStundenplan(conn, id).get(klasseID),
request, ServerMode.STABLE,
BenutzerKompetenz.STUNDENPLAN_ALLGEMEIN_ANSEHEN);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy