Package ch.ivyteam.ivy.application.calendar

Class 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. A IBusinessCalendarConfiguration can contain multiple FreeDayOfWeeks to define free days recurring every week, usually the weekend.
    API:
    This is a public API.

    • Constructor Detail

      • FreeDayOfWeek

        public FreeDayOfWeek​(Weekday dayOfWeek)
        Parameters:
        dayOfWeek - the day of the week
        Throws:
        IllegalArgumentException - if dayOfWeek 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 week
        description - the description
        Throws:
        IllegalArgumentException - if dayOfWeek 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.

      • 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 - if dayOfWeek is null
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.