com.adobe.fiber.runtime.lib.DateTimeFunc - Adobe® Flex® 4 Language Reference (Flex 4)

Package	com.adobe.fiber.runtime.lib
Class	public class DateTimeFunc
Inheritance	DateTimeFunc Object

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

The DateTimeFunc class defines the implementations of the expression runtime functions for Date and Time functions in the Adobe application modeling language.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		createDate(year:int, month:int, day:int, hour:int, minute:int, second:int):Date [static] Creates a date in the local timezone.	DateTimeFunc
		createDateUTC(year:int, month:int, day:int, hour:int, minute:int, second:int):Date [static] Creates a date in the UTC timezone.	DateTimeFunc
		dateAdd(part:String, units:int, date:Date):Date [static] Adds units of time to a date.	DateTimeFunc
		dateCompare(date1:Date, date2:Date):int [static] Takes two dates and returns -1, 0, or 1 depending on whether the first is smaller, equal or larger than the second.	DateTimeFunc
		dateDiff(part:String, date1:Date, date2:Date):Number [static] Takes a String datepart and two Dates and returns an int number of dateparts between the two Dates.	DateTimeFunc
		datePart(part:String, date:Date):int [static] Takes a String datepart and a Date and it returns the int value of that part.	DateTimeFunc
		datePartUTC(part:String, date:Date):int [static] Takes a String datepart and a Date and it returns the int value of that part.	DateTimeFunc
		dayOfWeek(date:Date):int [static] Returns the int day of week value of a Date param.	DateTimeFunc
		dayOfYear(date:Date):int [static] Returns the day of year corresponding to a date input.	DateTimeFunc
		daysInMonth(date:Date):int [static] Returns the number of days in a month.	DateTimeFunc
		daysInYear(date:Date):int [static] Returns the number of days in a given year.	DateTimeFunc
		firstDayOfMonth(date:Date):int [static] Returns the ordinal (the day's number in the year) for the first day of the specified month.	DateTimeFunc
		getDay(date:Date):int [static] Returns the int day value of a Date param.	DateTimeFunc
		getDayUTC(date:Date):int [static] Returns the int day value of a Date param.	DateTimeFunc
		getHour(date:Date):int [static] Returns the int hour value of a Date param.	DateTimeFunc
		getHourUTC(date:Date):int [static] Returns the int hour value of a Date param.	DateTimeFunc
		getMinute(date:Date):int [static] Returns the int minute value of a Date param.	DateTimeFunc
		getMinuteUTC(date:Date):int [static] Returns the int minute value of a Date param.	DateTimeFunc
		getMonth(date:Date):int [static] Returns the int month value of a Date param.	DateTimeFunc
		getMonthUTC(date:Date):int [static] Returns the int month value of a Date param.	DateTimeFunc
		getQuarter(date:Date):int [static] Returns the int quarter value of a Date param.	DateTimeFunc
		getSecond(date:Date):int [static] Returns the int second value of a Date param.	DateTimeFunc
		getSecondUTC(date:Date):int [static] Returns the int second value of a Date param.	DateTimeFunc
		getYear(date:Date):int [static] Returns the int year value of a Date param.	DateTimeFunc
		getYearUTC(date:Date):int [static] Returns int year value of a Date param.	DateTimeFunc
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isLeapYear(year:int):Boolean [static] Returns a boolean indicating whether a year is a leap year or not.	DateTimeFunc
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		now():Date [static] Returns the current date and time.	DateTimeFunc
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		today():Date [static] Returns the current date and time (legacy).	DateTimeFunc
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		weekOfYear(date:Date):int [static] Returns the week of the year for a Date.	DateTimeFunc
		years(endDate:Date, startDate:Date):int [static] Returns the number of years between two dates.	DateTimeFunc

Method Detail

createDate

()

method

public static function createDate(year:int, month:int, day:int, hour:int, minute:int, second:int):Date

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Creates a date in the local timezone.

Parameters

	`year:int` — year

	`month:int` — month

	`day:int` — day

	`hour:int` — hour

	`minute:int` — minute

	`second:int` — second

Returns

Date — a new date

createDateUTC

()

method

public static function createDateUTC(year:int, month:int, day:int, hour:int, minute:int, second:int):Date

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Creates a date in the UTC timezone.

Parameters

	`year:int` — Year

	`month:int` — Month

	`day:int` — Day

	`hour:int` — Hour

	`minute:int` — Minute

	`second:int` — Second

Returns

Date — New date

dateAdd

()

method

public static function dateAdd(part:String, units:int, date:Date):Date

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Adds units of time to a date. Units are:

yyyy: Year
q: Quarter
m: Month
y: Day of year
d: Day
w: Weekday
ww: Week
h: Hour
n: Minute
s: Second
l: Millisecond

Parameters

	`part:String` — Type of units to add

	`units:int` — Number of units

	`date:Date` — Date

Returns

Date — New date; null if date is null

dateCompare

()

method

public static function dateCompare(date1:Date, date2:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Takes two dates and returns -1, 0, or 1 depending on whether the first is smaller, equal or larger than the second.

Parameters

	`date1:Date` — First date for comparison

	`date2:Date` — Second date for comparison

Returns

int — int; -1 if date1 < date2, 0 if date1=date2, 1 if date1 > date2. Returns 0 if either date is null;

dateDiff

()

method

public static function dateDiff(part:String, date1:Date, date2:Date):Number

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Takes a String datepart and two Dates and returns an int number of dateparts between the two Dates.

Parameters

	`part:String` — String valid datepart

	`date1:Date` — Date first comparison date

	`date2:Date` — Date second comparison date

Returns

Number — Value representing number of dateparts between date1 and date2. Returns zero if either date is null;

Throws

Error — if bad part

datePart

()

method

public static function datePart(part:String, date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Takes a String datepart and a Date and it returns the int value of that part.

Parameters

	`part:String` — String valid date part (yyyy, m, y, d, w, ww, h, n, s)

	`date:Date` — Date for which part should be returned

Returns

int — Value representing datepart for given Date. Returns zero if date is null.

datePartUTC

()

method

public static function datePartUTC(part:String, date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Takes a String datepart and a Date and it returns the int value of that part.

Parameters

	`part:String` — String valid date part (yyyy, m, y, d, w, ww, h, n, s)

	`date:Date` — Date for which part should be returned

Returns

int — Value representing datepart for given Date. Returns zero if date is null.

dayOfWeek

()

method

public static function dayOfWeek(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int day of week value of a Date param.

Parameters

date:Date — Date for which day of week will be returned

Returns

int — Day of week of input date. Returns -1 if date is null.

dayOfYear

()

method

public static function dayOfYear(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the day of year corresponding to a date input.

Parameters

date:Date — Date for which day of year will be returned

Returns

int — Day of year corresponding to date input. Returns -1 if date is null.

daysInMonth

()

method

public static function daysInMonth(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the number of days in a month.

Parameters

date:Date — Date for which number of days in month will be returned

Returns

int — Number of days in this month. Returns zero if date is null.

daysInYear

()

method

public static function daysInYear(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the number of days in a given year.

Parameters

date:Date — Date for which number of days in year will be returned

Returns

int — Number of days this year. Returns zero if date is null.

firstDayOfMonth

()

method

public static function firstDayOfMonth(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the ordinal (the day's number in the year) for the first day of the specified month.

Parameters

date:Date — Date for which first day of month will be returned

Returns

int — Ordinal for the first day of month param. Returns zero if date is null.

getDay

()

method

public static function getDay(date:Date):int

Returns the int day value of a Date param.

Parameters

date:Date — Date for which day will be returned

Returns

int — Day of input date. Returns zero if date is null.

getDayUTC

()

method

public static function getDayUTC(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int day value of a Date param.

Parameters

date:Date — Date for which day will be returned

Returns

int — Day of input date. Returns zero if date is null.

getHour

()

method

public static function getHour(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int hour value of a Date param.

Parameters

date:Date — Date for which hour will be returned

Returns

int — Hour of input date. Returns -1 if date is null.

getHourUTC

()

method

public static function getHourUTC(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int hour value of a Date param.

Parameters

date:Date — Date for which hour will be returned

Returns

int — Hour of input date. Returns -1 if date is null.

getMinute

()

method

public static function getMinute(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int minute value of a Date param.

Parameters

date:Date — Date for which minute will be returned

Returns

int — Minute of input date. Returns -1 if date is null.

getMinuteUTC

()

method

public static function getMinuteUTC(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int minute value of a Date param.

Parameters

date:Date — Date for which minute will be returned

Returns

int — Minute of input date. Return -1 if date is null.

getMonth

()

method

public static function getMonth(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int month value of a Date param.

Parameters

date:Date — Date for which month will be returned

Returns

int — Month of input date. Returns 0 if date is null.

getMonthUTC

()

method

public static function getMonthUTC(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int month value of a Date param.

Parameters

date:Date — Date for which month will be returned

Returns

int — month of input date. Returns 0 if date is null.

getQuarter

()

method

public static function getQuarter(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int quarter value of a Date param.

Parameters

date:Date — Date for which quarter will be returned

Returns

int — Quarter of input date (1-4). Returns 0 if date is null.

getSecond

()

method

public static function getSecond(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int second value of a Date param.

Parameters

date:Date — Date for which second will be returned

Returns

int — Second of input date. Returns -1 if date is null.

getSecondUTC

()

method

public static function getSecondUTC(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int second value of a Date param.

Parameters

date:Date — Date for which second will be returned

Returns

int — Second of input date. Returns -1 if date is null.

getYear

()

method

public static function getYear(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the int year value of a Date param.

Parameters

date:Date — Date for which Year will be returned

Returns

int — Year of input date. Returns zero if date is null.

getYearUTC

()

method

public static function getYearUTC(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns int year value of a Date param.

Parameters

date:Date — Date for which Year will be returned

Returns

int — Year of input date. Returns zero if date is null.

isLeapYear

()

method

public static function isLeapYear(year:int):Boolean

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns a boolean indicating whether a year is a leap year or not. Differ in logic in years before 1582 (follow Java calendar class).

Parameters

year:int — int year

Returns

Boolean — Boolean indicating whether year is a leap year

now

()

method

public static function now():Date

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the current date and time.

Returns

Date

today

()

method

public static function today():Date

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the current date and time (legacy).

Returns

Date

weekOfYear

()

method

public static function weekOfYear(date:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the week of the year for a Date.

Parameters

date:Date

Returns

int — Week of the year. Returns zero if date is null.

years

()

method

public static function years(endDate:Date, startDate:Date):int

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the number of years between two dates.

Parameters

	`endDate:Date` — End date

	`startDate:Date` — Starting date

Returns

int — Numbers of years between the start and end dates. Returns -1 if either date is null.