Package ch.ivyteam.ivy.application.calendar

Interface IBusinessCalendarConfiguration

public interface IBusinessCalendarConfiguration

Defines the free days and working time of a IBusinessCalendar.

IBusinessCalendarConfiguration are stored in a hierarchy.
At the root of the hierarchy is always the default IBusinessCalendarConfiguration (see IBusinessCalendarSettings.getRootBusinessCalendarConfiguration()).
A IBusinessCalendarConfiguration inherits all configuration from its parent IBusinessCalendarConfigurations.
A free day or WorkingTime of a parent IBusinessCalendarConfiguration cannot be changed or removed in its children.

Example: add easter day as free easter relative day.

 businessCalendarConfiguration.getFreeEasterRelativeDays().add(new FreeEasterRelativeDay(0));

API:
This is a public API.

  • Method Details

    • getName

      String getName()
      Returns the name of this calendar
      Returns:
      the name
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getParent

      IBusinessCalendarConfiguration getParent()
      Returns the parent of this IBusinessCalendarConfiguration.
      Returns:
      the parent or null if this is the default IBusinessCalendarConfiguration
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • setParent

      void setParent(IBusinessCalendarConfiguration parent)
      Sets the parent IBusinessCalendarConfiguration. This causes this calendar to use all settings of the parent IBusinessCalendarConfiguration in addition to its own settings.
      Parameters:
      parent - the parent to set. Never null.
      Throws:
      IllegalArgumentException - if parent is the same as this or this is an ancestor of parent
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getFirstDayOfWeek

      Weekday getFirstDayOfWeek()
      Returns the first day of the week. Default is Weekday.MONDAY
      Returns:
      the first day of week. Never null.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • setFirstDayOfWeek

      void setFirstDayOfWeek(Weekday firstDayOfWeek)
      Sets the first day of the week to firstDayOfWeek
      Parameters:
      firstDayOfWeek - the first day of the week to set
      Throws:
      IllegalArgumentException - if firstDayOfWeek is null
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getWorkingTimes

      List<WorkingTime> getWorkingTimes()

      Returns a list of WorkingTimes defining which time of a day is working time.

      If no working times are defined an empty list is returned.

      Returns:
      the working times. Never null.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getFreeEasterRelativeDays

      List<FreeEasterRelativeDay> getFreeEasterRelativeDays()
      Returns a list of all free days relative to easter day. If no free days are defined an empty list is returned.
      Returns:
      the free days relative to easter day. Never null.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getFreeDaysOfYear

      List<FreeDayOfYear> getFreeDaysOfYear()
      Returns a list of all annual free days. If no free days are defined an empty list is returned.
      Returns:
      the free days of the year. Never null.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getFreeDaysOfWeek

      List<FreeDayOfWeek> getFreeDaysOfWeek()
      Returns a list with all weekly free days. If no free days are defined an empty list is returned.
      Returns:
      the free days of the week. Never null.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getFreeDates

      List<FreeDate> getFreeDates()
      Returns a list with all non-recurring free dates. If no free dates are defined an empty list is returned.
      Returns:
      the free dates. Never null.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.