| 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 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 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 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
|
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;
|
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 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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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
Returns | Boolean — Boolean indicating whether year is a leap year
|
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 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 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
Returns | int — Week of the year. Returns zero if date is null.
|
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.
|
Object
Hide Inherited Public Properties
Show Inherited Public Properties