hirondelle.formula.function.builtin
Class Weekday

Object
  hirondelle.formula.function.builtin.Weekday

All Implemented Interfaces:

Function

public final class Weekday
extends Object
implements Function

weekday(year, month, day): the day of the week for the given calendar day.

Constructor Summary

Weekday()

Method Summary

Decimal

calculate(Decimal... aArgs) Returns 1 for Sunday, 2 for Monday, and so on.

Methods inherited from class Object

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

Constructor Detail

Weekday

public Weekday()

Method Detail

calculate

public Decimal calculate(Decimal... aArgs)

Returns 1 for Sunday, 2 for Monday, and so on.

Takes 3 parameters for year-month-day (in that order). The day may contain a fraction. Uses Check.date(Decimal, Decimal, Decimal).

Specified by:

calculate in interface Function

Parameters:

aArgs - 0 or more arguments to the function.