Package de.svws_nrw.data.datenaustausch

Klasse DataUntis

java.lang.Object
de.svws_nrw.data.datenaustausch.DataUntis
public final class DataUntis extends Object
Diese Klasse stellt Methoden für den Import und Export von Untis-Daten zur Vefügung.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    static jakarta.ws.rs.core.Response
    exportGPU003(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt)
    Erzeugt den Export der Klassenliste des angegebenen Schuljahresabschnittes für Untis (Datei GPU003.txt) und gibt diese als Response zurück.
    static jakarta.ws.rs.core.Response
    exportGPU004(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt)
    Erzeugt den Export der Lehrerliste des angegebenen Schuljahresabschnittes für Untis (Datei GPU004.txt) und gibt diese als Response zurück.
    static jakarta.ws.rs.core.Response
    exportGPU006(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt)
    Erzeugt den Export der Fächer- bzw- Kursliste des angegebenen Schuljahresabschnittes für Untis (Datei GPU006.txt) und gibt diese als Response zurück.
    static jakarta.ws.rs.core.Response
    exportGPU010(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, int idVariante)
    Erzeugt den Export der Schülerliste des angegebenen Schuljahresabschnittes für Untis (Datei GPU010.txt) und gibt diese als Response zurück.
    static jakarta.ws.rs.core.Response
    exportGPU015(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, InputStream gpu002, int idVariante)
    Erzeugt den Export der Kurs-Fachwahlen des angegebenen Schuljahresabschnittes für Untis (Datei GPU015.txt) und gibt diese als Response zurück.
    static jakarta.ws.rs.core.Response
    exportGPU017(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, InputStream gpu002, int idVariante)
    Erzeugt den Export die Klausurdaten des angegebenen Schuljahresabschnittes für Untis (Datei GPU017.txt) und gibt diese als Response zurück.
    static jakarta.ws.rs.core.Response
    exportGPU019(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, InputStream gpu002)
    Erzeugt den Export der Schienenzuordnungen des angegebenen Schuljahresabschnittes für Untis (Datei GPU019.txt) und gibt diese als Response zurück.
    static jakarta.ws.rs.core.Response
    exportUntisBlockungsergebnisse(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, LongAndStringLists params, int idVariante)
    Erzeugt den Export eines Blockungsergebnisses für Untis, indem die Dateien GPU002.txt, GPU015.txt und GPU019.txt erzeugt werden und in einem Liste von Strings in dieser Reihenfolge in der Response zurückgegeben werden.
    static jakarta.ws.rs.core.Response
    importGPU001(DBEntityManager conn, UntisGPU001MultipartBody multipart, boolean ignoreMissing)
    Importiert die in dem Multipart übergebene Datei.
    static jakarta.ws.rs.core.Response
    importGPU005(DBEntityManager conn, SimpleBinaryMultipartBody multipart)
    Importiert die in dem Multipart übergebene Datei.
    static boolean
    importUntisRaeume(DBEntityManager conn, Logger logger, byte[] csv)
    Importiert Räume aus der Untis-Datei GPU005.txt in das Datenbank-Schema, welches durch die übergebene Verbindung festgelegt ist.

    Von Klasse geerbte Methoden java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Methodendetails

    • importGPU001

      public static jakarta.ws.rs.core.Response importGPU001(DBEntityManager conn, UntisGPU001MultipartBody multipart, boolean ignoreMissing)
      Importiert die in dem Multipart übergebene Datei.
      Parameter:
      conn - die Datenbank-Verbindung
      multipart - der Multipart-Body mmit der Datei
      ignoreMissing - wenn true, dann werden fehlende Klassen und Kurse ignoriert und protokolliert, es wird aber kein Fehler erzeugt.
      Gibt zurück:
      die HTTP-Response mit dem Log

    • importGPU005

      public static jakarta.ws.rs.core.Response importGPU005(DBEntityManager conn, SimpleBinaryMultipartBody multipart)
      Importiert die in dem Multipart übergebene Datei.
      Parameter:
      conn - die Datenbank-Verbindung
      multipart - der Multipart-Body mmit der Datei
      Gibt zurück:
      die HTTP-Response mit dem Log

    • importUntisRaeume

      public static boolean importUntisRaeume(DBEntityManager conn, Logger logger, byte[] csv) throws ApiOperationException
      Importiert Räume aus der Untis-Datei GPU005.txt in das Datenbank-Schema, welches durch die übergebene Verbindung festgelegt ist.
      Parameter:
      conn - die Datenbank-Verbindung.
      logger - der Logger für Rückmeldungen zum Import-Prozess
      csv - die CSV-Datei mit den Räumen (GPU005.txt)
      Gibt zurück:
      true im Erfolgsfall und false im Fehlerfall
      Löst aus:
      ApiOperationException - im Fehlerfall

    • exportGPU003

      public static jakarta.ws.rs.core.Response exportGPU003(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt) throws ApiOperationException
      Erzeugt den Export der Klassenliste des angegebenen Schuljahresabschnittes für Untis (Datei GPU003.txt) und gibt diese als Response zurück.
      Parameter:
      conn - die Datenbank-Verbindung
      logger - der Logger
      idSchuljahresabschnitt - die ID des Schuljahresabschnittes
      Gibt zurück:
      eine Response mit der CSV-Datei
      Löst aus:
      ApiOperationException - wenn ein Fehler beim Erstellen des Exportes auftritt

    • exportGPU004

      public static jakarta.ws.rs.core.Response exportGPU004(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt) throws ApiOperationException
      Erzeugt den Export der Lehrerliste des angegebenen Schuljahresabschnittes für Untis (Datei GPU004.txt) und gibt diese als Response zurück.
      Parameter:
      conn - die Datenbank-Verbindung
      logger - der Logger
      idSchuljahresabschnitt - die ID des Schuljahresabschnittes
      Gibt zurück:
      eine Response mit der CSV-Datei
      Löst aus:
      ApiOperationException - wenn ein Fehler beim Erstellen des Exportes auftritt

    • exportGPU006

      public static jakarta.ws.rs.core.Response exportGPU006(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt) throws ApiOperationException
      Erzeugt den Export der Fächer- bzw- Kursliste des angegebenen Schuljahresabschnittes für Untis (Datei GPU006.txt) und gibt diese als Response zurück.
      Parameter:
      conn - die Datenbank-Verbindung
      logger - der Logger
      idSchuljahresabschnitt - die ID des Schuljahresabschnittes
      Gibt zurück:
      eine Response mit der CSV-Datei
      Löst aus:
      ApiOperationException - wenn ein Fehler beim Erstellen des Exportes auftritt

    • exportGPU010

      public static jakarta.ws.rs.core.Response exportGPU010(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, int idVariante) throws ApiOperationException
      Erzeugt den Export der Schülerliste des angegebenen Schuljahresabschnittes für Untis (Datei GPU010.txt) und gibt diese als Response zurück. Dabei werden nur Schüler mit dem Status AKTIV, EXTERN, NEUAUFNAHME und WARTELISTE berücksichtigt.
      Parameter:
      conn - die Datenbank-Verbindung
      logger - der Logger
      idSchuljahresabschnitt - die ID des Schuljahresabschnittes
      idVariante - die Variante für den Schüler-Bezeichner (1, 2 oder 3 - siehe UntisSchuelerBezeichner)
      Gibt zurück:
      eine Response mit der CSV-Datei
      Löst aus:
      ApiOperationException - wenn ein Fehler beim Erstellen des Exportes auftritt

    • exportGPU015

      public static jakarta.ws.rs.core.Response exportGPU015(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, InputStream gpu002, int idVariante) throws ApiOperationException
      Erzeugt den Export der Kurs-Fachwahlen des angegebenen Schuljahresabschnittes für Untis (Datei GPU015.txt) und gibt diese als Response zurück.
      Parameter:
      conn - die Datenbank-Verbindung
      logger - der Logger
      idSchuljahresabschnitt - die ID des Schuljahresabschnittes
      gpu002 - die GPU002-Datei als String
      idVariante - die Variante für den Schüler-Bezeichner (1, 2 oder 3 - siehe UntisSchuelerBezeichner)
      Gibt zurück:
      eine Response mit der CSV-Datei
      Löst aus:
      ApiOperationException - wenn ein Fehler beim Erstellen des Exportes auftritt

    • exportGPU017

      public static jakarta.ws.rs.core.Response exportGPU017(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, InputStream gpu002, int idVariante) throws ApiOperationException
      Erzeugt den Export die Klausurdaten des angegebenen Schuljahresabschnittes für Untis (Datei GPU017.txt) und gibt diese als Response zurück.
      Parameter:
      conn - die Datenbank-Verbindung
      logger - der Logger
      idSchuljahresabschnitt - die ID des Schuljahresabschnittes
      gpu002 - die GPU002-Datei als String
      idVariante - die Variante für den Schüler-Bezeichner (1, 2 oder 3 - siehe UntisSchuelerBezeichner)
      Gibt zurück:
      eine Response mit der CSV-Datei
      Löst aus:
      ApiOperationException - wenn ein Fehler beim Erstellen des Exportes auftritt

    • exportGPU019

      public static jakarta.ws.rs.core.Response exportGPU019(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, InputStream gpu002) throws ApiOperationException
      Erzeugt den Export der Schienenzuordnungen des angegebenen Schuljahresabschnittes für Untis (Datei GPU019.txt) und gibt diese als Response zurück.
      Parameter:
      conn - die Datenbank-Verbindung
      logger - der Logger
      idSchuljahresabschnitt - die ID des Schuljahresabschnittes
      gpu002 - die GPU002-Datei als String
      Gibt zurück:
      eine Response mit der CSV-Datei
      Löst aus:
      ApiOperationException - wenn ein Fehler beim Erstellen des Exportes auftritt

    • exportUntisBlockungsergebnisse

      public static jakarta.ws.rs.core.Response exportUntisBlockungsergebnisse(DBEntityManager conn, Logger logger, long idSchuljahresabschnitt, LongAndStringLists params, int idVariante) throws ApiOperationException
      Erzeugt den Export eines Blockungsergebnisses für Untis, indem die Dateien GPU002.txt, GPU015.txt und GPU019.txt erzeugt werden und in einem Liste von Strings in dieser Reihenfolge in der Response zurückgegeben werden.
      Parameter:
      conn - die Datenbank-Verbindung
      logger - der Logger
      idSchuljahresabschnitt - die ID des Schuljahresabschnittes
      params - die Abiturjahre und die GPU002 als Parameter
      idVariante - die Variante für den Schüler-Bezeichner (1, 2 oder 3 - siehe UntisSchuelerBezeichner)
      Gibt zurück:
      eine Response mit den drei Strings in einer Liste
      Löst aus:
      ApiOperationException - im Fehlerfall