Package de.elo.mover.main

Class Intervall

java.lang.Object
de.elo.mover.main.Intervall
public class Intervall
extends java.lang.Object

Überschrift: Intervall.

Beschreibung: Methoden zur Verwaltung der ELOas Intervalle.

Copyright: Copyright (c) ELO Digital Office GmbH 2018

  • Constructor Summary

    Constructors 
    Constructor Description
    Intervall()
    Erzeugt ein leeres, ungültiges Intervall Objekt.
    Intervall​(java.lang.String description)
    Erzeugt ein neues Intervall Objekt aus der Textbeschreibung.

  • Method Summary

    Modifier and Type Method Description
    boolean checkRun​(java.util.Calendar now)
    Prüft nach, ob das Intervall zu dem angegebenen Zeitpunkt ausgeführt werden soll.
    java.lang.String displayNextRun()
    Gibt eine Textdarstellung für den nächsten geplanten Ausführungszeitpunkt zurück.
    int getDayInMonth()
    Gibt den Ausführungstag zurück wenn es ein "einmal pro Monat" Intervall ist.
    int getDayInWeek()
    Gibt den Ausführungswochentag zurück wenn es ein "einmal pro Woche" Intervall ist.
    int getHourOfDay()
    Gibt die Ausführungs-Stunde zurück wenn es ein tägliches, wöchentliches oder monatliches Intervall ist.
    boolean getIsDailyInterval()
    Getter für das IsDailyInterval Property.
    boolean getIsMinuteInterval()
    Getter für das IsMinuteInterval Property.
    int getMinuteOfHour()
    Gibt die Ausführungs-Minute zurück wenn es ein tägliches, wöchentliches oder monatliches Intervall ist.
    int getMinutes()
    Gibt die Intervalldauer in Minuten zurück wenn es ein regelmäßiges Intervall ist.
    int getSeconds()
    Gibt die Intervalldauer in Sekunden zurück wenn es in regelmäßiges Intervall ist.
    boolean isDailyType​(int minutes)
    Prüft nach, ob das aktuelle Objekt gültig ist und ein Täglich-Intervall enthält.
    boolean isIntervallType​(int minutes)
    Prüft nach, ob das aktuelle Objekt gültig ist und ein Minuten oder Stundenintervall mit der spezifizierten Zeit in Minuten enthält.
    boolean isManuallyTriggered()
    Meldet zurück, ob das Intervall ein periodisches oder manuell getriggertes Intervall ist.
    boolean isMonthlyType​(int minutes, int monthday)
    Prüft nach, ob das aktuelle Objekt gültig ist und ein Einmal-Pro-Monat-Intervall enthält.
    boolean isShortIntervallType​(int seconds)
    Prüft nach, ob das aktuelle Objekt gültig ist und ein Sekundenintverall mit der spezifizierten Zeit in Sekunden enthält.
    boolean isValid()
    Prüft nach, ob ein gültig initialisiertes Intervall vorhanden ist.
    boolean isWeeklyType​(int minutes, int weekday)
    Prüft nach, ob das aktuelle Objekt gültig ist und ein Einmal-Pro-Woche-Intervall enthält.
    void setDayInMonth​(int value)
    Setzt den Ausführungstag (1..31 oder -1 falls kein Monatsintervall).
    void setDayInWeek​(int value)
    Setzt den Ausführungstag (0..6 oder -1 falls kein Wochentag).
    void setHourOfDay​(int value)
    Gibt die Ausführungs-Stunde zurück wenn es ein tägliches, wöchentliches oder monatliches Intervall ist.
    void setIsDailyInterval​(boolean isDailyInterval)
    Setter für das IsDailyInterval Property.
    void setIsMinuteInterval​(boolean isMinuteInterval)
    Setter für das IsMinuteInterval Property.
    void setMinuteOfHour​(int value)
    Gibt die Ausführungs-Minute zurück wenn es ein tägliches, wöchentliches oder monatliches Intervall ist.
    void setMinutes​(int value)
    Setzt die Intervalldauer in Minuten.
    void setSeconds​(int value)
    Setz die Intervalldauer in Sekunden.
    java.lang.String toString()
    Erzeugt aus dem aktuellen Intervall Objekt die Textdarstellung zur Anzeige oder zum Erzeugen gleichartiger Objekte.
    void triggerNext​(java.util.Calendar now)
    Nach der Ausführung wird über diese Funktion der nächste Ausführungstermin eingeplant.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Intervall

      public Intervall()
      Erzeugt ein leeres, ungültiges Intervall Objekt. Bevor es verwendet werden kann, muss es mit einer Zeiteinstellung gefüllt werden.

    • Intervall

      public Intervall​(java.lang.String description)
      Erzeugt ein neues Intervall Objekt aus der Textbeschreibung. Falls die Beschreibung fehlerhaft ist, wird trotzdem ein Intervall Objekt zurückgegeben, dieses hat aber im Property valid dann FALSE eingetragen.
      Parameters:
      description - Textbeschreibung des Intervalls

  • Method Details

    • displayNextRun

      public java.lang.String displayNextRun()
      Gibt eine Textdarstellung für den nächsten geplanten Ausführungszeitpunkt zurück. Falls noch kein Termin geplant ist, wird eine entsprechende Meldung geliefert.
      Returns:
      nächste Ausführung

    • getDayInMonth

      public int getDayInMonth()
      Gibt den Ausführungstag zurück wenn es ein "einmal pro Monat" Intervall ist.
      Returns:
      Tagesnummer 1..31, oder -1 bei anderen Intervall Typ

    • setDayInMonth

      public void setDayInMonth​(int value)
      Setzt den Ausführungstag (1..31 oder -1 falls kein Monatsintervall).
      Parameters:
      value - Ausführungstag

    • getDayInWeek

      public int getDayInWeek()
      Gibt den Ausführungswochentag zurück wenn es ein "einmal pro Woche" Intervall ist.
      Returns:
      Tagesnummer 0..6, oder -1 bei anderen Intervall Typ

    • setDayInWeek

      public void setDayInWeek​(int value)
      Setzt den Ausführungstag (0..6 oder -1 falls kein Wochentag).
      Parameters:
      value - Ausführungstag

    • getHourOfDay

      public int getHourOfDay()
      Gibt die Ausführungs-Stunde zurück wenn es ein tägliches, wöchentliches oder monatliches Intervall ist.
      Returns:
      Stunde

    • setHourOfDay

      public void setHourOfDay​(int value)
      Gibt die Ausführungs-Stunde zurück wenn es ein tägliches, wöchentliches oder monatliches Intervall ist.
      Parameters:
      value - Stunde

    • getMinuteOfHour

      public int getMinuteOfHour()
      Gibt die Ausführungs-Minute zurück wenn es ein tägliches, wöchentliches oder monatliches Intervall ist.
      Returns:
      Minute

    • setMinuteOfHour

      public void setMinuteOfHour​(int value)
      Gibt die Ausführungs-Minute zurück wenn es ein tägliches, wöchentliches oder monatliches Intervall ist.
      Parameters:
      value - Minute

    • getMinutes

      public int getMinutes()
      Gibt die Intervalldauer in Minuten zurück wenn es ein regelmäßiges Intervall ist. Wenn es sich um ein Sekundenintervall handelt, wird auf die nächste volle Minute aufgerundet.
      Returns:
      Minuten

    • getSeconds

      public int getSeconds()
      Gibt die Intervalldauer in Sekunden zurück wenn es in regelmäßiges Intervall ist. Anderfalls ist der Rückgabewert undefiniert.
      Returns:
      Intervalldauer in Sekunden

    • setMinutes

      public void setMinutes​(int value)
      Setzt die Intervalldauer in Minuten.
      Parameters:
      value - Intervalldauer in Minuten

    • setSeconds

      public void setSeconds​(int value)
      Setz die Intervalldauer in Sekunden.
      Parameters:
      value - Intervalldauer in Sekunden

    • checkRun

      public boolean checkRun​(java.util.Calendar now)
      Prüft nach, ob das Intervall zu dem angegebenen Zeitpunkt ausgeführt werden soll. Wenn ein Intervall noch nicht gelaufen ist und es sich um ein Minuten oder Stundentermin handelt, dann wird es sofort ausgeführt. Falls es sich um ein Tagestermin handelt, dann wird der Termin zum nächstmöglichen Zeitpunkt eingeplant.
      Parameters:
      now - Ausführungszeitpunkt
      Returns:
      Ausführen

    • triggerNext

      public void triggerNext​(java.util.Calendar now)
      Nach der Ausführung wird über diese Funktion der nächste Ausführungstermin eingeplant. Der Parameter now enthält im Normalfall das Ende der Operation. Bei Minuten- oder Stundenintervallen beginnt der nächste Lauf also x-Minuten nach dem Ende der letzten Aktion, nicht nach dem Start.
      Parameters:
      now - Endezeitpunkt der Operation

    • isManuallyTriggered

      public boolean isManuallyTriggered()
      Meldet zurück, ob das Intervall ein periodisches oder manuell getriggertes Intervall ist. Ein manuell getriggertes Intervall wird nicht zeitabhängig sondern nur auf spezielle Anforderung hin ausgeführt.
      Returns:
      manuelles Intervall, nicht periodisch getriggert

    • toString

      public java.lang.String toString()
      Erzeugt aus dem aktuellen Intervall Objekt die Textdarstellung zur Anzeige oder zum Erzeugen gleichartiger Objekte.
      Overrides:
      toString in class java.lang.Object
      Returns:
      Textdarstellung

    • isIntervallType

      public boolean isIntervallType​(int minutes)
      Prüft nach, ob das aktuelle Objekt gültig ist und ein Minuten oder Stundenintervall mit der spezifizierten Zeit in Minuten enthält.
      Parameters:
      minutes - Zeitintervall
      Returns:
      Es ist ein Minuten oder Stundenintervall

    • isShortIntervallType

      public boolean isShortIntervallType​(int seconds)
      Prüft nach, ob das aktuelle Objekt gültig ist und ein Sekundenintverall mit der spezifizierten Zeit in Sekunden enthält.
      Parameters:
      seconds - Zeitintervall
      Returns:
      Es ist ein Minuten oder Stundenintervall

    • getIsMinuteInterval

      public boolean getIsMinuteInterval()
      Getter für das IsMinuteInterval Property. Dieser Aufruf prüft nicht nach, ob ein gültiges Intervall vorliegt, es wird nur der aktuelle Wert des Properties zurück gegeben.
      Returns:
      Proptery Wert von MinutenIntervall

    • setIsMinuteInterval

      public void setIsMinuteInterval​(boolean isMinuteInterval)
      Setter für das IsMinuteInterval Property. Dieser Aufruf prüft nicht nach, ob ein gültiges Intervall vorliegt, es wird nur der aktuelle Wert des Properties verändert.
      Parameters:
      isMinuteInterval - Neuer Wert für das MinutenIntevall

    • getIsDailyInterval

      public boolean getIsDailyInterval()
      Getter für das IsDailyInterval Property. Dieser Aufruf prüft nicht nach, ob ein gültiges Intervall vorliegt, es wird nur der aktuelle Wert des Properties zurück gegeben.
      Returns:
      Proptery Wert von DailyIntervall

    • setIsDailyInterval

      public void setIsDailyInterval​(boolean isDailyInterval)
      Setter für das IsDailyInterval Property. Dieser Aufruf prüft nicht nach, ob ein gültiges Intervall vorliegt, es wird nur der aktuelle Wert des Properties verändert.
      Parameters:
      isDailyInterval - Neuer Wert für das DailyIntevall

    • isDailyType

      public boolean isDailyType​(int minutes)
      Prüft nach, ob das aktuelle Objekt gültig ist und ein Täglich-Intervall enthält. Der Parameter gibt die Uhrzeit der Ausführung an.
      Parameters:
      minutes - Ausführungszeitpunkt in Minuten
      Returns:
      Es ist ein Täglich-Intervall

    • isWeeklyType

      public boolean isWeeklyType​(int minutes, int weekday)
      Prüft nach, ob das aktuelle Objekt gültig ist und ein Einmal-Pro-Woche-Intervall enthält. Der Parameter minutes gibt die Uhrzeit der Ausführung an, weekday den Tag innerhalb der Woche.
      Parameters:
      minutes - Ausführungszeitpunkt in Minuten
      weekday - Ausführungstag
      Returns:
      Es ist ein Wochen-Intervall

    • isMonthlyType

      public boolean isMonthlyType​(int minutes, int monthday)
      Prüft nach, ob das aktuelle Objekt gültig ist und ein Einmal-Pro-Monat-Intervall enthält. Der Parameter minutes gibt die Uhrzeit der Ausführung an, monthday den Tag innerhalb des Monats.
      Parameters:
      minutes - Ausführungszeitpunkt in Minuten
      monthday - Ausführungstag
      Returns:
      Es ist ein Monats-Intervall

    • isValid

      public boolean isValid()
      Prüft nach, ob ein gültig initialisiertes Intervall vorhanden ist.
      Returns:
      Intervall ist gültig