Function

Description

addBusinessDays

Adds a given number of business days to a DateTime or a Date.

addDays

Adds a number of days to a DateTime or a Date.

addHours

Adds a number of hours to a DateTime.

addMinutes

Adds a number of minutes to a DateTime.

calculateWorkingHours

Returns how many minutes are within, and outside working hours for a particular Date Range.

createDate

Retuns a Date when given the year,month, day of month.

createDateTime

Retuns a DateTime when given the year,month, day of month, hour and minute.

createDateRange

Returns a DateRange when given two DateTime's.

dayOfMonth

Returns the day of the month of a Date or a Date Time.

dayOfWeek

Returns the day of the week of a Date or a Date Time.

hour

Returns the hour of a Date Time.

intersect

Returns how many minutes the two DateRanges, four DateTimes or DateRange and two DateTime's intersect by.

isBusinessDay

Returns whether a day in a DateTime or a Date is a business day.

isRangeOutsideWorkingHours

Returns whether a Date Range is outside the specified working hours.

millisecond

Returns the millisecond a DateTime.

minute

Returns the minute of a DateTime.

minuteOfDay

Returns the minute of the day of a DateTime.

month

Returns the month of a DateTime or a Date.

monthZeroBased

Returns the month of a DateTime or a Date with January as 0.

parseDate

Returns the parsed Date.

parseDateTime

Returns the parsed DateTime.

second

Returns the second of a DateTime.

setDayOfMonth

Sets the dayOfMonth in a DateTime or a Date.

setHour

Sets the hour in a DateTime.

setMillisecond

Sets the millisecond in a DateTime.

setMinute

Sets the minute in a DateTime.

setMinuteOfDay

Sets the minuteOfDay in a DateTime.

setMonth

Sets the month in a DateTime or a Date.

setMonthZeroBased

Sets the month based on January being 0, in a DateTime or a Date.

setSecond

Sets the second in a DateTime.

setYear

Sets the year in a DateTime or a Date.

subtractBusinessDays

Returns the Date after subtracting a number of business days.

subtractDays

Subtracts a number of days to a DateTime or a Date.

subtractHours

Subtracts a number of hours to a DateTime.

subtractMinutes

Subtracts a number of minutes to a DateTime.

timeDiffBusinessDays

Returns how many business days there are between two DatesDateTimes

timeDiffDays

Returns the difference in days between two DateTimes or two Dates

timeDiffHours

Returns the difference in hours between two DateTimes

timeDiffMilliseconds

Returns the difference in milliseconds between two DateTimes

timeDiffMinutes

Returns the difference in minutes between two DateTimes

timeDiffSeconds

Returns the difference in seconds between two DateTimes

weekOfYear

Returns the wek of the year of a Date or a DateTime.

year

Returns the year of a Date or a DateTime.

addBusinessDays

addBusinessDays

 

Allows the addition of a number of business days (as Integer) to either a DateTime or a Date. Returns the new DateTime or Date.

addDays

addDays

 

Allows the addition of a number of days (as Integer or Double) to either a DateTime or a Date. Returns the new DateTime or Date.

addHours

addHours

 

Allows the addition of a number of hours (as Integer or Double) to a DateTime. Returns the new DateTime.

addMinutes

addMinutes

 

Allows the addition of a number of minutes (as Integer or Double) to a DateTime. Returns the new DateTime.

calculateWorkingHours

Click to expand

 

Calculates how many minutes of a Date Range are in and out of working hours.

Takes Integer startWorkingMinuteOfDay: the start minute of the working day. For example, 0 for midnight, 480 for 8am and 510 for 8.30am.

Takes Integer finishWorkingMinuteOfDay: the finish minute of the day. For example, 1220 for 5pm, 1280 for 6pm and 1440 for midnight.

Takes Date Time rangeStart: the start of the period that you want to do the calculation for.

Takes Date Time rangeFinish: the finish of the period that you want to do the calculation for.

Returns how many minutes are inside working hours and how many minutes are outside working hours . Outside working hours is defined by the weekend, and holidays, as defined by Holiday Date Biskits, or outside the standard working hours as indicated by [startWorkingMinuteOfDay, finishWorkingMinuteOfDay].

createDate

createDate

Takes a year, month, day of month and returns the Date.

createDateTime

createDateTime

Takes a year, month, day of month, hour, minute and optionally second, and returns the DateTime.

createDateRange

createDateRange

Takes two DateTime's or optionally null, and returns the DateRange. If the null option is used the DateRange returned is from now until December 31st 2999.

dayOfMonth

dayOfMonth

Takes a Date or Date Time and returns the day of the month.

dayOfWeek

dayOfWeek

Takes a Date or Date Time and returns the day of the week.

hour

hour

Takes a Date Time and returns the hour.

intersect

dateIntersect

 

Calculates how many minutes two DateRange's, four DateTime's or a combination of a DateRange and two DateTime's overlap by. Returns the number of minutes as an Integer.

isBusinessDay

isBusinessDay

Takes a Date or Date Time and returns whether it is a business day or not.

isRangeOutsideWorkingHours

Click to expand

 

Checks whether any of the period between two times is outside working hours.

Takes Integer startWorkingMinuteOfDay: the start minute of the working day. For example, 0 for midnight, 480 for 8am and 510 for 8.30am.

Takes Integer finishWorkingMinuteOfDay: the finish minute of the day. For example, 1220 for 5pm, 1280 for 6pm and 1440 for midnight.

Takes Date Time rangeStart: the start of the period that you want to check for being outside working hours.

Takes Date Time rangeFinish: the finish of the period that you want to check for being outside working hours.

Returns true when the range [rangeStart, rangeFinish] covers any period that is not inside working hours. That means a weekend, holiday, as defined by Holiday Date Biskits, or outside the standard working hours as indicated by [startWorkingMinuteOfDay, finishWorkingMinuteOfDay].

millisecond

millisecond

Takes a Date Time and returns the millisecond.

minute

minute

Takes a Date Time and returns the minute.

minuteOfDay

minuteOfDay

Takes a Date Time and returns the minute of the day.

month

month

Takes a Date or Date Time and returns the month.

monthZeroBased

monthZeroBased

Takes a Date or Date Time and returns the month with January as 0.

parseDate

parseDate

Takes a String and returns the parsed Date. The user can provide a date format to assist the parsing, or specify that its US date format.

parseDateTime

parseDateTime

Takes a String and returns the parsed DateTime. The user can provide a date format to assist the parsing, or specify that its US date format.

second

second

Takes a Date Time and returns the second.

setDayOfMonth

setDayOfMonth

Takes a Date or DateTime and the day of the month as an Integer and returns the new Date or Date Time.

setHour

setHour

Takes a Date Time and the hour as an Integer and returns the new Date Time.

setMillisecond

setMillisecond

Takes a Date Time and the millisecond as an Integer and returns the new Date Time.

setMinute

setMinute

Takes a Date Time and the minute as an Integer and returns the new Date Time.

setMinuteOfDay

setMinuteOfDay

Takes a Date Time and the minute as an Integer and returns the new Date Time.

setMonth

setMonth

Takes a Date or DateTime and the month as an Integer and returns the new Date or Date Time.

setMonthZeroBased

setMonthZeroBased

Takes a Date or DateTime and the month as an Integer where January is 0, returns the new Date or Date Time.

setSecond

setSecond

Takes a Date Time and the second as an Integer and returns the new Date Time.

setYear

setYear

Takes a Date or DateTime and the year as an Integer and returns the new Date or Date Time.

subtractBusinessDays

subtractBusinessDays

 

Allows the subtraction of a number of business days (as Integer) from a DateTime or a Date. Returns the new DateTime or Date.

subtractDays

subtractDays

 

Allows the subtraction of a number of days (as Integer or Double) from a DateTime or a Date. Returns the new DateTime or Date.

subtractHours

subtractHours

 

Allows the subtraction of a number of hours (as Integer or Double) from a DateTime. Returns the new DateTime.

subtractMinutes

subtractMinutes

 

Allows the subtraction of a number of minutes (as Integer or Double) from a DateTime. Returns the new DateTime.

timeDiffBusinessDays

timeDiffBusinessDays

 

Calculates the difference in business days between two DateTimes or Dates. Returns the difference in days as an Integer or a Double

timeDiffDays

timeDiffDays

 

Calculates the difference in days between two DateTimes or Dates. Returns the difference in days as an Integer or a Double.

timeDiffHours

timeDiffHours

 

Calculates the difference in hours between two DateTimes. Returns the difference in hours as an Integer.

 

timeDiffMilliseconds

timeDiffMilliseconds

 

Calculates the difference in milliseconds between two DateTimes. Returns the difference in milliseconds as an Integer.

timeDiffMinutes

timeDiffMinutes

 

Calculates the difference in minutes between two DateTimes. Returns the difference in minutes as an Integer.

timeDiffSeconds

timeDiffSeconds

 

Calculates the difference in seconds between two DateTimes. Returns the difference in seconds as an Integer.

weekOfYear

weekOfYear

Takes a Date or Date Time and returns the week of the year.

year

year

Takes a Date or Date Time and returns the year.