Package de.svws_nrw.module.reporting.html

Enum-Klasse HtmlTemplateDefinition

java.lang.Object
java.lang.Enum<HtmlTemplateDefinition>
de.svws_nrw.module.reporting.html.HtmlTemplateDefinition
Alle implementierten Schnittstellen:
Serializable, Comparable<HtmlTemplateDefinition>, Constable
public enum HtmlTemplateDefinition extends Enum<HtmlTemplateDefinition>

Eine ENUM der integrierten Report-Vorlagen des SVWS-Servers. Sie definiert die im CoreType ReportingReportvorlage angelegten Report-Vorlagen hinsichtlich der verwendeten Template-Dateien und Benutzerrechte genauer.

Hinweis:

Jede Templatedefinition hat eine Pfadangabe für den Root-Pfad und eine zur html-Templatedatei. Letztere Angabe hat relativ zum Root zu erfolgen.

Hinweis:

Die Bezeichnungen der ENUM-Werte dienen auch dazu, die Daten-Contexts korrekt zu füllen. Die Benennung der Vorlagen erfolgt nach dem Schema Hauptdaten_v_Detaildaten. Bei der Report-Generierung erfolgt in Teilen ein entsprechendes Füllen der Datenkontexte anhand der Benennung.

Anmerkung:

Es gibt zwei Einträge für die Erzeugung des Dateinamens. Einen "statischen" Dateinamen und eine Dateinamensvorlage. Die Vorlage stellt den BODY eines html-Thymeleaf-Templates dar, welches eine einzige Zeile mit einem Absatz-Tag ergeben muss. Diese Zeile wird dann für die Erzeugung des Dateinamens aus den Daten genutzt.

  • Enum-Konstanten - Details

    • GOST_KLAUSURPLANUNG_v_KLAUSURTERMINE_MIT_KURSEN

      public static final HtmlTemplateDefinition GOST_KLAUSURPLANUNG_v_KLAUSURTERMINE_MIT_KURSEN
      Report-Vorlage: GOSt - Klausurplanung - Klausurtermine - Kurse

    • GOST_KLAUSURPLANUNG_v_SCHUELER_MIT_KLAUSUREN

      public static final HtmlTemplateDefinition GOST_KLAUSURPLANUNG_v_SCHUELER_MIT_KLAUSUREN
      Report-Vorlage: GOSt - Klausurplanung - Schueler - Klausuren

    • GOST_KURSPLANUNG_v_KURS_MIT_KURSSCHUELERN

      public static final HtmlTemplateDefinition GOST_KURSPLANUNG_v_KURS_MIT_KURSSCHUELERN
      Report-Vorlage: GOSt - Kursplanung - Kurs - Kurschüler

    • GOST_KURSPLANUNG_v_KURSE_MIT_STATISTIKWERTEN

      public static final HtmlTemplateDefinition GOST_KURSPLANUNG_v_KURSE_MIT_STATISTIKWERTEN
      Report-Vorlage: GOSt - Kursplanung - Kurse - Statistikwerten

    • GOST_KURSPLANUNG_v_SCHUELER_MIT_KURSEN

      public static final HtmlTemplateDefinition GOST_KURSPLANUNG_v_SCHUELER_MIT_KURSEN
      Report-Vorlage: GOSt - Kursplanung - Schüler - Kurse

    • GOST_KURSPLANUNG_v_SCHUELER_MIT_SCHIENEN_KURSEN

      public static final HtmlTemplateDefinition GOST_KURSPLANUNG_v_SCHUELER_MIT_SCHIENEN_KURSEN
      Report-Vorlage: GOSt - Kursplanung - Schüler - Schienen-Kurse

    • SCHUELER_v_GOST_ABITUR_APO_ANLAGE_12

      public static final HtmlTemplateDefinition SCHUELER_v_GOST_ABITUR_APO_ANLAGE_12
      Report-Vorlage: Schüler - GOSt - Abitur - APO - Anlage 12 (Abiturzeugnis)

    • SCHUELER_v_GOST_LAUFBAHNPLANUNG_ERGEBNISUEBERSICHT

      public static final HtmlTemplateDefinition SCHUELER_v_GOST_LAUFBAHNPLANUNG_ERGEBNISUEBERSICHT
      Report-Vorlage: Schüler - GOSt - Laufbahnplanung - Ergebnisübersicht

    • SCHUELER_v_GOST_LAUFBAHNPLANUNG_WAHLBOGEN

      public static final HtmlTemplateDefinition SCHUELER_v_GOST_LAUFBAHNPLANUNG_WAHLBOGEN
      Report-Vorlage: Schüler - GOSt - Laufbahnplanung - Wahlbogen

    • SCHUELER_v_STAMMDATEN_LISTE

      public static final HtmlTemplateDefinition SCHUELER_v_STAMMDATEN_LISTE
      Report-Vorlage: Schüler - Stammdaten - Liste

  • Methodendetails

    • values

      public static HtmlTemplateDefinition[] values()
      Gibt ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration zurück.
      Gibt zurück:
      ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration

    • valueOf

      public static HtmlTemplateDefinition valueOf(String name)
      Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück. Die Zeichenfolge muss exakt mit einer ID übereinstimmen, mit der eine Enum-Konstante in dieser Klasse deklariert wird. (Zusätzliche Leerzeichen sind nicht zulässig.)
      Parameter:
      name - Name der zurückzugebenden Enumerationskonstante.
      Gibt zurück:
      Enumerationskonstante mit dem angegebenen Namen
      Löst aus:
      IllegalArgumentException - wenn diese Enum-Klasse keine Konstante mit dem angegebenen Namen enthält
      NullPointerException - wenn das Argument nicht angegeben wird

    • getReportingReportvorlage

      public ReportingReportvorlage getReportingReportvorlage()
      Gibt den CoreType ReportingReportvorlage dieser Template-Definition zurück
      Gibt zurück:
      Der CoreType dieser Template-Definition

    • getRootPfad

      public String getRootPfad()
      Der Root-Pfad zum Verzeichnis, unter dem alle Dateien dieser HtmlTemplateDefinition (html, css, fonts) auffindbar sind.
      Gibt zurück:
      Der Root-Pfad zur HtmlTemplateDefinition

    • getPfadHtmlTemplate

      public String getPfadHtmlTemplate()
      Pfad zur html-Template-Datei. Angabe erfolgt relativ zum Root-Pfad.
      Gibt zurück:
      Der Dateipfad zur html-Template-Datei

    • getRootPfadHtmlTemplate

      public String getRootPfadHtmlTemplate()
      Pfad zur html-Template-Datei, inklusive des Root-Pfads der HtmlTemplateDefinition.
      Gibt zurück:
      Der Root-Dateipfad zur html-Template-Datei

    • getDateiname

      public String getDateiname()
      Gibt den statischen Dateinamen ohne Dateiendung zurück, der bei der Ausgabe als ZIP-Datei verwendet wird.
      Gibt zurück:
      Der statische Dateiname

    • getDateinamensvorlage

      public String getDateinamensvorlage()
      Gibt die Vorlage für die dynamische Generierung des Dateinamens ohne Dateiendung zurück.
      Gibt zurück:
      Die Vorlage für den Dateinamen

    • getBenutzerKompetenzen

      public List<BenutzerKompetenz> getBenutzerKompetenzen()
      Gibt die Benutzer-Kompetenzen für diese Template-Definition zurück
      Gibt zurück:
      Die Liste der Benutzerkompetenzen

    • getByType

      public static HtmlTemplateDefinition getByType(ReportingReportvorlage reportingReportvorlage)
      Diese Methode ermittelt die Report-Vorlage anhand des übergebenen Namens.
      Parameter:
      reportingReportvorlage - Der CoreType der Report-Vorlage
      Gibt zurück:
      Die Template-Definition