org.openlowcode.server.data.properties.schedule

Class WorkCalendarHelper

java.lang.Object

org.openlowcode.server.data.properties.schedule.WorkCalendarHelper

public class WorkCalendarHelper
extends java.lang.Object

This class performs scheduling functions around a calendar object. It especially provides:

• a caching system to avoid requesting data in database several times
• logic to provide services based on calendar data

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkCalendarHelper.CalendarTimeSlot a utility class to store a timeslot in time.

Constructor Summary

Constructors

Constructor and Description
WorkCalendarHelper(Workcalendar calendar) Creates a new helper for the specified work calendar

Method Summary

Modifier and Type	Method and Description
void	createbufferarounddate(java.util.Date date) creates a buffer of periods that are 1 year before and 2 years after the date given.
long	getActiveDurationInMinutes(java.util.Date starttime, java.util.Date endtime) this method provides the active duration in minutes between startime and endtime.
WorkCalendarHelper.CalendarTimeSlot[]	getAllSlotsForTimeSlot(java.util.Date starttime, java.util.Date endtime) creates slots as followed: one slot per intersection of the timeslot and business open period if a slot ends outside business hours, it should be created as between the end of the last business slot and the invalid date if a slot starts outside business houlrs, it should be created as between the invalid date and the start of the business day
java.util.Date	getEndDate(java.util.Date starttime, long lengthinminute) gets the end date for the period
java.util.Date	getNextEndDate(java.util.Date newstartdate, long l)
java.util.Date	getNextStartDate(java.util.Date endtime) get next start date valid for the timeslot.
java.lang.String	getWorkCalendarString() This method returns a compact String encoding a work calendar.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkCalendarHelper

public WorkCalendarHelper(Workcalendar calendar)

Creates a new helper for the specified work calendar

Parameters:

calendar - the calendar to use

Method Detail

getWorkCalendarString

public java.lang.String getWorkCalendarString()

This method returns a compact String encoding a work calendar. This can be used on the client side whenever knowing the work calendar is required (e.g. to display schedule). The String is made of a succession of weekly slots and then of holidays
Weekly Slot is defined with following format:

• 3 Digits code for definition of days:
  • D01: Monday
  • D02: Tuesday
  • D03: Wednesday
  • D04: Thursday
  • D05: Friday
  • D06: Saturday
  • D07: Sunday
  • D15: Monday to Friday
  • D16: Monday to Saturday
  • D17: Everyday
• start hours in two digits
• start minutes in two digits
• end hour in two digits
• end minutes in two digits

After weekly slot, a pipe '|' is sent in the String The holidays are encoded as followed:

• day in two digits
• months in two digits
• year in 4 digits. If year is not set, NNNN is returned

Returns:

createbufferarounddate

public void createbufferarounddate(java.util.Date date)

creates a buffer of periods that are 1 year before and 2 years after the date given. This is the range on which the planning will be managed correctly

Parameters:

date - the start date

getNextStartDate

public java.util.Date getNextStartDate(java.util.Date endtime)

get next start date valid for the timeslot.

Parameters:

endtime - endtime of the previous slot

Returns:

the next valid date. It is typically either end-date, or the start time of the next working slot

getActiveDurationInMinutes

public long getActiveDurationInMinutes(java.util.Date starttime,
                                       java.util.Date endtime)

this method provides the active duration in minutes between startime and endtime. Only time in an active timeslot is counted. For example, if active timeslot is 8am to 6pm, the active timeslot between 5pm and 9am the next day is 2 hours (5 to 6pm on the first day, 8 to 9am on the second day

Parameters:

starttime -

endtime -

Returns:

getEndDate

public java.util.Date getEndDate(java.util.Date starttime,
                                 long lengthinminute)

gets the end date for the period

Parameters:

starttime - the start of the slot (typically got through getNextStartDate)

lengthinminute - length of the slot in minutes

Returns:

the endDate. Note: if the slot includes several working slots, the endDate may NOT be be in the same working slot as the start date

getAllSlotsForTimeSlot

public WorkCalendarHelper.CalendarTimeSlot[] getAllSlotsForTimeSlot(java.util.Date starttime,
                                                                    java.util.Date endtime)

creates slots as followed:

• one slot per intersection of the timeslot and business open period
• if a slot ends outside business hours, it should be created as between the end of the last business slot and the invalid date
• if a slot starts outside business houlrs, it should be created as between the invalid date and the start of the business day

Parameters:

starttime - start of the timeslot

endtime - end of the timeslot

Returns:

an array of calendar time slots, according to the given rule.

getNextEndDate

public java.util.Date getNextEndDate(java.util.Date newstartdate,
                                     long l)

Parameters:

newstartdate - start date of the new period

l - length in minute

Returns:

the end date