Interface ConfigurationAreaManagementInfo


public interface ConfigurationAreaManagementInfo
Ein Eintrag in den Verwaltungsinformationen der Konfiguration. Für jeden Konfigurationsbereich wird ein Eintrag erstellt. Zu jedem Eintrag wird die Pid des Konfigurationsbereichs, der Speicherort der entsprechenden Konfigurationsbereichsdatei und die Versionsnummern mit ihren Aktivierungszeiten, gespeichert.
  • Method Summary

    Modifier and Type Method Description
    VersionInfo getActiveVersion()
    Gibt die aktive Version des Konfigurationsbereichs und ihren Aktivierungszeitpunkt zurück.
    java.io.File getDirectory()
    Gibt den Speicherort (Verzeichnis) der Datei des Konfigurationsbereichs zurück.
    java.lang.String getPid()
    Gibt die Pid des Konfigurationsbereichs eines Verwaltungseintrages zurück.
    int getPosition()
    Gibt die Position innerhalb aller Konfigurationsbereiche in den Verwaltungsdaten zurück.
    java.util.List<VersionInfo> getVersions()
    Gibt alle Versionseinträge zu diesem Konfigurationsbereich in einer Liste zurück.
    boolean isNewVersionActivated()
    Gibt an, ob beim Laden der Verwaltungsinformationen, dieser Konfigurationsbereich in eine neue Version überführt wurde.
    void setDirectory​(java.io.File directory)
    Setzt den Speicherort (das Verzeichnis) der Datei des Konfigurationsbereichs.
    void setNextActiveVersion​(short nextActiveVersion)
    Es wird die Versionsnummer angegeben, in welche dieser Konfigurationsbereich beim Neustart der Konfiguration überführt werden soll.
    void setPosition​(int position)
    Mit dieser Methode soll die Reihenfolge der Konfigurationsbereiche verändert werden können.
  • Method Details

    • getPid

      java.lang.String getPid()
      Gibt die Pid des Konfigurationsbereichs eines Verwaltungseintrages zurück.
      Returns:
      die Pid des Konfigurationsbereichs
    • getDirectory

      java.io.File getDirectory()
      Gibt den Speicherort (Verzeichnis) der Datei des Konfigurationsbereichs zurück.
      Returns:
      Der Speicherort (Verzeichnis) der Konfigurationsbereichsdatei oder null wenn das Verzeichnis nicht ermittelt werden kann.
    • setDirectory

      void setDirectory​(java.io.File directory)
      Setzt den Speicherort (das Verzeichnis) der Datei des Konfigurationsbereichs.
      Parameters:
      directory - der Speicherort (das Verzeichnis) der Konfigurationsbereichsdatei
    • setNextActiveVersion

      void setNextActiveVersion​(short nextActiveVersion)
      Es wird die Versionsnummer angegeben, in welche dieser Konfigurationsbereich beim Neustart der Konfiguration überführt werden soll. Die erste zu aktivierende Version muss größer gleich 1 sein.
      Parameters:
      nextActiveVersion - Die nächste aktive Version. Sie muss größer sein, als die bisherigen aktiven Versionsnummern.
    • isNewVersionActivated

      boolean isNewVersionActivated()
      Gibt an, ob beim Laden der Verwaltungsinformationen, dieser Konfigurationsbereich in eine neue Version überführt wurde.
      Returns:
      true, wenn dieser Konfigurationsbereich in eine neue Version überführt wurde, sonst false.
    • getActiveVersion

      VersionInfo getActiveVersion()
      Gibt die aktive Version des Konfigurationsbereichs und ihren Aktivierungszeitpunkt zurück.
      Returns:
      die aktive Version und ihren Aktivierungszeitpunkt des Konfigurationsbereichs
    • getVersions

      java.util.List<VersionInfo> getVersions()
      Gibt alle Versionseinträge zu diesem Konfigurationsbereich in einer Liste zurück.
      Returns:
      eine Liste aller Versionseinträge zu diesem Konfigurationsbereich
    • getPosition

      int getPosition()
      Gibt die Position innerhalb aller Konfigurationsbereiche in den Verwaltungsdaten zurück. (siehe auch TPuK1-99 Reihenfolge der Bereiche)
      Returns:
      Position innerhalb der Konfigurationsbereiche
    • setPosition

      void setPosition​(int position)
      Mit dieser Methode soll die Reihenfolge der Konfigurationsbereiche verändert werden können. Der angegebene Wert gibt die Position zwischen 1 und der Anzahl aller eingetragenen Konfigurationsbereiche an. Andere Werte sind nicht erlaubt. (siehe auch TPuK1-99 Reihenfolge der Bereiche)
      Parameters:
      position - Position innerhalb der Konfigurationsbereiche