Package ch.ivyteam.ivy.application.calendar

Class WorkingTime

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

Defines a time span during the day when work is done.

A IBusinessCalendarConfiguration can contain multiple WorkingTimes. For example 08:00-12:00 and 13:00-17:00

WorkingTimes can overlap. For Example 08:00 - 11:00 and 10:00 - 12:00.

WorkingTimes can embed other WorkingTimes. For Example 08:00 - 11:00 and 9:00 - 10:00.

API:
This is a public API.

  • Constructor Details

    • WorkingTime

      public WorkingTime(Time start, Time end)
      Parameters:
      start - the start of the working time. Never null.
      end - the end of the working time. Never null.
      Throws:
      IllegalArgumentException - if start or end is null.
      API:
      This public API is available in Java.

    • WorkingTime

      public WorkingTime(Time start, Time end, String description)
      Parameters:
      start - the start of the working time. Never null.
      end - the end of the working time. Never null.
      description - the description
      Throws:
      IllegalArgumentException - if start, end or description is null.
      API:
      This public API is available in Java.

  • Method Details

    • getDescription

      public String getDescription()
      Returns the description
      Returns:
      the description
      API:
      This public API is available in Java.

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

    • getStart

      public Time getStart()
      Returns start of the working time.
      Returns:
      the start. Never null.
      API:
      This public API is available in Java.

    • setStart

      public void setStart(Time start)
      Sets the start of the working time.
      Parameters:
      start - the start to set. Never null.
      Throws:
      IllegalArgumentException - if start is null.
      API:
      This public API is available in Java.

    • getEnd

      public Time getEnd()
      Returns the end of the working time.
      Returns:
      the end. Never null.
      API:
      This public API is available in Java.

    • setEnd

      public void setEnd(Time end)
      Sets the end of the working time.
      Parameters:
      end - the end to set. Never null.
      Throws:
      IllegalArgumentException - if end is null
      API:
      This public API is available in Java.