Package ch.ivyteam.ivy.application.calendar

Class FreeDayOfYear

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

Free day recurring every Year. A IBusinessCalendarConfiguration can contain multiple FreeDayOfYears to define free days recurring every year.

This is used to define annual public holidays.

API:
This is a public API.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FreeDayOfYear(int month, int day)
     
    FreeDayOfYear(int month, int day, String description)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getDay()
    Returns the day of the free day The day has a range from 1-31
    String
    getDescription()
    Returns the description
    int
    getMonth()
    Returns the month of the free day.
    void
    setDay(int day)
    Sets the day of the free day The day has a range from 1-31
    void
    setDescription(String description)
    Sets the description to the given parameter
    void
    setMonth(int month)
    Sets the month of the free day.

  • Constructor Details

    • FreeDayOfYear

      public FreeDayOfYear(int month, int day)
      Parameters:
      month - Must be in Range 1-12.
      day - Must be in Range 1-31.
      Throws:
      IllegalArgumentException - if month or day is out of range
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • FreeDayOfYear

      public FreeDayOfYear(int month, int day, String description)
      Parameters:
      month - Must be in Range 1-12.
      day - Must be in Range 1-31.
      description - the description
      Throws:
      IllegalArgumentException - if month or day is out of range or description is null
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

  • Method Details

    • 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.

    • getMonth

      public int getMonth()
      Returns the month of the free day. The month has a range from 1-12
      Returns:
      the month
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • setMonth

      public void setMonth(int month)
      Sets the month of the free day. The month has a range from 1-12
      Parameters:
      month - the month to set
      Throws:
      IllegalArgumentException - if the month is not in range.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • getDay

      public int getDay()
      Returns the day of the free day The day has a range from 1-31
      Returns:
      the day
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.

    • setDay

      public void setDay(int day)
      Sets the day of the free day The day has a range from 1-31
      Parameters:
      day - the day to set
      Throws:
      IllegalArgumentException - if the day is not in range.
      API:
      This public API is available in IvyScript and Java. It has the visibility EXPERT.