
package de.ivu.elect.business.ergebnis.entity;

/**
 * ÄNDERUNGEN AN DIESER KLASSE MÜSSEN IN DEN DOKUMENTVORLAGEN NACHGEZOGEN WERDEN! In der Vorlage
 * "gesamt-ergebnis-Niederschrift_Ergebnisausschuss_ABW.odt" wird direkt auf die Namen der Arten verwiesen
 *
 * siehe auch {@link de.ivu.elect.presentation.ergebnis.dokumente.gesamtergebnis.ErgebnisLogEintragDokument}
 *
 * Die Idee ist, dass die ErgebnisLogEintrag'e zusammen ein Dokument bilden, das durch Formatierung einigermaßen lesbar
 * wird. Als Mittel der Formatierung stehen zur Verfügung:
 * <ul>
 * <li>Einen Einträge Titel des Dokuments festzulegen</li>
 * <li>Einträge als Überschriften in drei Ebenen festzulegen</li>
 * <li>Einträge besonders hervorzuheben als Fehler (höchste Hervorhebungsstufe), Warnung (mittlere Hervorhebungsstufe)
 * oder Hinweis (niedrigste Hervorhebungsstufe)</li>
 * <li>Leerzeilen als reines Formatierungswerkzeug, z.B. vor uns nach einer Reihe von Einträgen, die untereinander einen
 * engen Zusammenhang haben, und nicht schon durch Überschriften separiert werden.</li>
 * <li>Einträge als Besonderheit festzulegen. Diese beschreiben besondere Vorkommnisse bei der Sitzverteilung wie Losen,
 * Mehrheitssicherungsklausel, Listenerschöpfung etc.</li>
 * </ul>
 */
public enum ErgebnisLogEintragArt {
  /** Ist der Standard für Log-Einträge */
  INFO,

  HINWEIS,

  WARNUNG,

  FEHLER,

  /** Markiert den Titel des Logs */
  TITEL,

  /** Gliederungsebenen des Logs, falls eine Gliederung gewünscht ist */
  UEBERSCHRIFT1,
  UEBERSCHRIFT2,
  UEBERSCHRIFT3,

  BESONDERHEIT,

  /** Dient der Trennung INFO-Log-Einträgen, die einen geringeren Zusammenhang haben. */
  LEERE_ZEILE
}
