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 FreeDayOfYear
s to define
free days recurring every year.
This is used to define annual public holidays.
- API:
- This is a public API.
-
Constructor Summary
ConstructorDescriptionFreeDayOfYear
(int month, int day) FreeDayOfYear
(int month, int day, String description) -
Method Summary
Modifier and TypeMethodDescriptionint
getDay()
Returns the day of the free day The day has a range from 1-31Returns the descriptionint
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-31void
setDescription
(String description) Sets the description to the given parametervoid
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 Java.
-
FreeDayOfYear
- 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 ordescription
is null- API:
- This public API is available in Java.
-
-
Method Details
-
getDescription
Returns the description- Returns:
- the description
- API:
- This public API is available in Java.
-
setDescription
Sets the description to the given parameter- Parameters:
description
- the description to set- API:
- This public API is available in Java.
-
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 Java.
-
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 themonth
is not in range.- API:
- This public API is available in Java.
-
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 Java.
-
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 theday
is not in range.- API:
- This public API is available in Java.
-