Interface ICalendar

All Superinterfaces:
Serializable
All Known Subinterfaces:
IWorkdayCalendar

public interface ICalendar extends Serializable
Base class for persisted calendar instance. Each calendar instance has an ID which is used to uniquely identify this calendar object when managing calendars using ICalendarManager. Calendar alias is another way to uniquely identify calendar object but it is different from calendar ID is that it is not auto-generated but specified when creating a calendar. Calendar alias is used to specify calendar instances on design time for processes and tasks

Each calendar is assosicated with timeZone ID, all time based events in this calendar such as Holidays or Workdays are applied within that timeZone

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    Calendar Type Unknown
    static final int
    Workday Calendar Type
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns unique alias for this calendar
    Returns ID of this calendar object
    Returns friendly display name for this calendar object
    Returns timeZone ID for this calendar
    int
    Returns type of this calendar object
    void
    Sets alias value for Calendar.
    void
    Sets display name for Calendar
    void
    setTimeZone(String timeZone)
    Sets timeZone ID for Calendar
  • Field Details

  • Method Details

    • getID

      String getID()
      Returns ID of this calendar object
      Returns:
    • getType

      int getType()
      Returns type of this calendar object
    • getName

      String getName()
      Returns friendly display name for this calendar object
    • getAlias

      String getAlias()
      Returns unique alias for this calendar
    • getTimeZone

      String getTimeZone()
      Returns timeZone ID for this calendar
    • setTimeZone

      void setTimeZone(String timeZone)
      Sets timeZone ID for Calendar
    • setName

      void setName(String name)
      Sets display name for Calendar
    • setAlias

      void setAlias(String alias)
      Sets alias value for Calendar.