Package com.uc4.api.objects

Class CalendarKeyword

java.lang.Object
com.uc4.api.objects.CalendarKeyword
Direct Known Subclasses:
GroupCalendarKeyword, MonthlyCalendarKeyword, RollCalendarKeyword, StaticCalendarKeyword, WeeklyCalendarKeyword, YearlyCalendarKeyword
public abstract class CalendarKeyword extends Object
Calendar Keyword.

  • Constructor Details

    • CalendarKeyword

      public CalendarKeyword()

  • Method Details

    • getErrorMessageNumber

      public int getErrorMessageNumber()
      Returns the number of the error message or 0 if there is no error in this calendar keyword.
      Returns:
      Integer containing the number of error message or 0 if there is no error

    • getErrorMessageInsert

      public String getErrorMessageInsert()
      Returns the insert string in case errorMessageNumber is not 0.
      Returns:
      Insert

    • getErrorText

      public String getErrorText()
      Returns the text of the error message or null if there is no error in this calendar keyword.
      Returns:
      Error message

    • setErrorMessageNumber

      protected void setErrorMessageNumber(int errorMessageNumber)

    • setErrorText

      protected void setErrorText(String errorText)

    • setErrorMessageInsert

      public void setErrorMessageInsert(String errorMessageInsert)
      Sets the error message insert.
      Parameters:
      errorMessageInsert - Insert

    • getName

      public UC4ObjectName getName()
      Returns the name of the Calendar Keyword.
      Returns:
      UC4ObjectName containing the calendar keyword

    • setName

      public void setName(UC4ObjectName name)
      Sets the name of the Calendar Keyword.
      Parameters:
      name - UC4ObjectName containing the calendar keyword

    • isStatic

      public abstract boolean isStatic()
      Returns true if this is a static keyword.
      Returns:
      Boolean containing true in case of a static keyword

    • isWeekly

      public abstract boolean isWeekly()
      Returns true if this is a weekly keyword.
      Returns:
      Boolean containing true in case of a weekly keyword

    • isMonthly

      public abstract boolean isMonthly()
      Returns true if this is a monthly keyword.
      Returns:
      Boolean containing true in case of a monthly keyword

    • isYearly

      public abstract boolean isYearly()
      Returns true if this is a yearly keyword.
      Returns:
      Boolean containing true in case of a yearly keyword

    • isGroup

      public abstract boolean isGroup()
      Returns true if this is a group keyword.
      Returns:
      Boolean containing true in case of a group keyword

    • isRoll

      public abstract boolean isRoll()
      Returns true if this is a roll keyword.
      Returns:
      Boolean containing true in case of a roll keyword

    • save

      protected abstract void save(com.uc4.util.XMLDocument doc, Element parent)
      Saves the keyword under the specified parent element
      Parameters:
      doc - XML Document
      parent - Parent element

    • setCalendarName

      protected void setCalendarName(String name)

    • getCalendarName

      public String getCalendarName()
      Returns the parent calendar object name, this is necessary to identify a calendar keyword
      Returns:
      object name of the parent calendar object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • invalidateCalculatedDates

      protected void invalidateCalculatedDates()

    • containsDate

      public boolean containsDate(DateTime date)
      Checks if a date matches this keyword. This method works with any type of keyword (roll, group, ...) It uses the precalculated dates from the Automation Engine. Therefore this method can only be called if no modification has been made to this keyword. If the keyword has been modified it is necessary to save and reopen this calendar in order to get a new list of calculated dates.
      Parameters:
      date - Date to check
      Returns:
      true if the specified date is part of this calendar keyword

    • loadCalculatedDays

      protected void loadCalculatedDays(Element keyword)

    • getPreCalculatedDates

      public SortedSet<DateTime> getPreCalculatedDates()
      Returns:
      a unmodifyable view on the precalculated dates