Package ch.ivyteam.ivy.application.calendar

Class FreeEasterRelativeDay

  • All Implemented Interfaces:
    ch.ivyteam.ivy.application.calendar.CalendarListEntry, Comparable<ch.ivyteam.ivy.application.calendar.CalendarListEntry>
    public final class FreeEasterRelativeDay
extends Object
implements ch.ivyteam.ivy.application.calendar.CalendarListEntry

    Free day relative to Easter Day.

    A IBusinessCalendarConfiguration can contain multiple FreeEasterRelativeDays to define free days recurring every year relative to Easter Day.

    The days since easter are in a range from -82 to +250 where 0 is the easter day. Negative numbers define a day before Easter Day. Positive numbers define a day after Easter Day.

    The range is limited as it is not allowed to define a relative day which is earlier than the beginning of the year or later than the end of the year.
    The last possible date for Easter Day is the 25. of April. Which leaves the maximum of 250 days to the end of the year.
    The earliest possible date for Easter Day is the 22. March. Which leaves the maximum of -82 days to the beginning of the year.

    API:
    This is a public API.

    • Constructor Detail

      • FreeEasterRelativeDay

        public FreeEasterRelativeDay​(int daysSinceEaster)
        Parameters:
        daysSinceEaster - the days since Easter Day
        Throws:
        IllegalArgumentException - if daysSinceEaster is not in range
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • FreeEasterRelativeDay

        public FreeEasterRelativeDay​(int daysSinceEaster,
                             String description)
        Parameters:
        daysSinceEaster - the days since Easter Day
        description - the description
        Throws:
        IllegalArgumentException - if daysSinceEaster is not in range or description is null
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • Method Detail

      • getDescription

        public String getDescription()
        Returns the description
        Returns:
        the description
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • setDescription

        public void setDescription​(String description)
        Sets the description to the given parameter
        Parameters:
        description - the description to set
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getDaysSinceEaster

        public int getDaysSinceEaster()

        Returns the days since Easter Day.

        Returns:
        the days since Easter Day
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • setDaysSinceEaster

        public void setDaysSinceEaster​(int daysSinceEaster)
        Sets the days since Easter Day
        Parameters:
        daysSinceEaster - the days since Easter Day to set
        Throws:
        IllegalArgumentException - if daysSinceEaster is out of range
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.