Class FreeDayOfWeek
- java.lang.Object
-
- ch.ivyteam.ivy.application.calendar.FreeDayOfWeek
-
- All Implemented Interfaces:
ch.ivyteam.ivy.application.calendar.CalendarListEntry
,Comparable<ch.ivyteam.ivy.application.calendar.CalendarListEntry>
public final class FreeDayOfWeek extends Object implements ch.ivyteam.ivy.application.calendar.CalendarListEntry
A free day recurring every week. AIBusinessCalendarConfiguration
can contain multipleFreeDayOfWeek
s to define free days recurring every week, usually the weekend.- API:
- This is a public API.
-
-
Constructor Summary
Constructors Constructor Description FreeDayOfWeek(Weekday dayOfWeek)
FreeDayOfWeek(Weekday dayOfWeek, String description)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Weekday
getDayOfWeek()
Returns the day of the weekString
getDescription()
Returns the descriptionvoid
setDayOfWeek(Weekday dayOfWeek)
Sets the day of the week to the given parametervoid
setDescription(String description)
Sets the description to the given parameter
-
-
-
Constructor Detail
-
FreeDayOfWeek
public FreeDayOfWeek(Weekday dayOfWeek)
- Parameters:
dayOfWeek
- the day of the week- Throws:
IllegalArgumentException
- ifdayOfWeek
is null- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
FreeDayOfWeek
public FreeDayOfWeek(Weekday dayOfWeek, String description)
- Parameters:
dayOfWeek
- the day of the weekdescription
- the description- Throws:
IllegalArgumentException
- ifdayOfWeek
ordescription
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.
-
getDayOfWeek
public Weekday getDayOfWeek()
Returns the day of the week- Returns:
- the day of the week. Never null
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
setDayOfWeek
public void setDayOfWeek(Weekday dayOfWeek)
Sets the day of the week to the given parameter- Parameters:
dayOfWeek
- the day of week to set- Throws:
IllegalArgumentException
- ifdayOfWeek
is null- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
-