Назад Далее

Класс BirtDateTime

Класс BirtDateTime предоставляет функции для определения интервала времени между двумя датами или значениями времени, для сложения и вычитания промежутков времени, а также для получения элементов значения даты. Поскольку значения интервалов времени представляют собой числа, для них допустимы обычные арифметические операции: умножение, деление, сложение, вычитание и так далее. Это статический класс. Приложения не могут создавать экземпляры данного класса.

BirtDateTime.addDay

Эта функция возвращает новую дату, которая является результатом добавления к дате указанного числа дней. Количество добавляемых дней может быть отрицательным. В этом случае указанное значение вычитается из указанной даты.

Синтаксис

Date BirtDateTime.addDay( Date date, Number n )

Параметры

date

Объект Date. Объект Date, соответствующий начальной дате.

n

Числовой объект. Число дней, добавляемых к дате. Десятичные числа обрабатываются как целые (округление до ближайшего целого).

Возвращает

Объект Date. Дата, полученная в результате добавления к начальной дате указанного числа дней.

Примеры

В следующих примерах к указанной дате добавляются дни:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addDay( startDate, 1 ); // возвращает 1 января 2009 г.
endDate = BirtDateTime.addDay( startDate, -1 ); // возвращает 30 декабря 2008 г.

В следующем примере к каждому значению даты в поле InvoiceDate добавляется 15 дней:

BirtDateTime.addDay( row["InvoiceDate"], 15 )

BirtDateTime.addHour

Эта функция возвращает новую дату, которая является результатом добавления к дате указанного числа часов. Количество добавляемых часов может быть отрицательным. В этом случае указанное значение вычитается из указанной даты.

Синтаксис

Date BirtDateTime.addHour( Date date, Number n )

Параметры

date

Объект Дата, соответствующий начальной дате. Если для начальной даты не указано значение времени, то данная функция в качестве значения времени примет полночь (00:00:00).

n

Числовой объект. Количество часов, которое нужно прибавить к дате.

Возвращает

Объект Date. Дата, полученная в результате добавления к начальной дате указанного числа часов.

Примеры

В следующих примерах к указанной дате и времени добавляются часы:

var startDate = "2008-12-31 15:00:00";
var endDate;
endDate = BirtDateTime.addHour( startDate, 8 ); // возвращает 31 декабря 2008 г., 23:00
endDate = BirtDateTime.addHour( startDate, -8 ); // возвращает 31 декабря 2008 г., 07:00

В следующем примере к каждому значению даты в поле StartTime добавляется 36 часов:

BirtDateTime.addHour( row["StartTime"], 36 )

BirtDateTime.addMinute

Эта функция возвращает новую дату, которая является результатом добавления к дате указанного числа минут. Количество добавляемых минут может быть отрицательным. В этом случае указанное значение вычитается из указанной даты.

Синтаксис

Date BirtDateTime.addMinute( Date date, Number n )

Параметры

date

Объект Дата, соответствующий начальной дате. Если для начальной даты не указано значение времени, то данная функция в качестве значения времени примет полночь (00:00:00).

n

Числовой объект. Количество минут, которое нужно прибавить к дате.

Возвращает

Объект Date. Дата, полученная в результате добавления к начальной дате указанного числа минут.

Примеры

В следующих примерах к указанной дате и времени добавляются минуты:

var startDate = "2008-12-31 10:30:00";
var endDate;
endDate = BirtDateTime.addMinute( startDate, 45 );
// возвращает 31 дек 2008 11:15
endDate = BirtDateTime.addMinute( startDate, -30 );
// возвращает 31 дек 2008 10:00

В следующем примере к каждому значению даты в поле StartTime добавляется 15 минут:

BirtDateTime.addMinute( row["StartTime"], 15 )

BirtDateTime.addMonth

Эта функция возвращает новую дату, которая является результатом добавления к дате указанного числа месяцев. Количество добавляемых месяцев может быть отрицательным. В этом случае указанное значение вычитается из указанной даты.

Данная функция всегда возвращает допустимое значение даты. При необходимости элемент даты, соответствующий дню в полученной дате, будет исправлен для отображения последнего дня полученного месяца в полученном году. Например, если требуется добавить 1 месяц к 31 янв 2008, то функция addMonth( ) возвратит 29 фев 2008 (2008 - високосный год), а не 31 фев 2008.

Синтаксис

Date BirtDateTime.addMonth( Date date, Number n )

Параметры

date

Объект Date. Объект Date, соответствующий начальной дате.

n

Числовой объект. Число месяцев, добавляемых к дате. Десятичные числа обрабатываются как целые (округление).

Возвращает

Объект Date. Дата, полученная в результате добавления к начальной дате указанного числа месяцев.

Примеры

В следующих примерах к указанной дате добавляются месяцы:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addMonth( startDate, 1 ); // возвращает 31 января 2009 г.
endDate = BirtDateTime.addMonth( startDate, -1 ); // возвращает 30 ноября 2008 г.
endDate = BirtDateTime.addMonth( startDate, 2 ); // возвращает 28 февраля 2009 г.

В следующем примере к каждому значению даты в поле InvoiceDate добавляется 10 месяцев:

BirtDateTime.addMonth( row["InvoiceDate"], 10 )

BirtDateTime.addQuarter

Эта функция возвращает новую дату, которая является результатом добавления к дате указанного числа кварталов. Квартал равнозначен трем месяцам. Например, если добавить 2 квартала к 10 сентября 2008 года, то функция возвратит 10 марта 2009 года. Количество добавляемых кварталов может быть отрицательным. В этом случае указанное значение вычитается из указанной даты.

Синтаксис

Date BirtDateTime.addQuarter( Date date, Number n )

Параметры

date

Объект Дата, соответствующий начальной дате.

n

Числовой объект. Число кварталов, добавляемых к дате.

Возвращает

Объект Date. Дата, полученная в результате добавления к начальной дате указанного числа кварталов.

Примеры

В следующих примерах к указанной дате добавляются кварталы:

var startDate = "2008-12-15";
var endDate;
endDate = BirtDateTime.addQuarter( startDate, 1 ); // возвращает 15 марта 2009 г.
endDate = BirtDateTime.addQuarter( startDate, -2 ); //возвращает 15 июня 2008 г.

В следующем примере к каждому значению даты в поле ForecastClosing добавляется 2 квартала:

BirtDateTime.addQuarter( row["ForecastClosing"], 2 )

BirtDateTime.addSecond

Эта функция возвращает новую дату, которая является результатом добавления к дате указанного числа секунд. Количество добавляемых секунд может быть отрицательным. В этом случае указанное значение вычитается из указанной даты.

Синтаксис

Date BirtDateTime.addSecond( Date date, Number n )

Параметры

date

Объект Дата, соответствующий начальной дате. Если для начальной даты не указано значение времени, то данная функция в качестве значения времени примет полночь (00:00:00).

n

Числовой объект. Число секунд, добавляемых к дате.

Возвращает

Объект Date. Результат добавления к начальной дате указанного числа секунд.

Примеры

В следующих примерах к указанной дате и времени добавляются секунды:

var startDate = "2008-12-31 10:30:00";
var endDate;
endDate = BirtDateTime.addSecond( startDate, 10000 );
// возвращает 31 дек 2008 13:16:40
endDate = BirtDateTime.addSecond( startDate, -10000 );
// возвращает 31 дек 2008 7:43:20

В следующем примере к каждому значению даты в поле StartTime добавляется 6000 секунд:

BirtDateTime.addSecond( row["StartTime"], 6000 )

BirtDateTime.addWeek

Эта функция возвращает новую дату, которая является результатом добавления к дате указанного числа недель. Количество добавляемых недель может быть отрицательным. В этом случае указанное значение вычитается из указанной даты.

Синтаксис

Date BirtDateTime.addWeek( Date date, Number n )

Параметры

date

Объект Дата, соответствующий начальной дате.

n

Числовой объект. Число недель, добавляемых к дате.

Возвращает

Объект Date. Дата, полученная в результате добавления к начальной дате указанного числа недель.

Примеры

В следующих примерах к указанной дате добавляются недели:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addWeek( startDate, 1 ); // возвращает 7 января 2009 г.
endDate = BirtDateTime.addWeek( startDate, -1 ); // возвращает 24 декабря 2008 г.

В следующем примере к каждому значению даты в поле InvoiceDate добавляется 2 недели:

BirtDateTime.addWeek( row["InvoiceDate"], 2 )

BirtDateTime.addYear

Эта функция возвращает новую дату, которая является результатом добавления к дате указанного числа лет. Количество добавляемых лет может быть отрицательным. В этом случае указанное значение вычитается из указанной даты.

Синтаксис

Date BirtDateTime.addYear( Date date, Number n )

Параметры

date

Объект Дата, соответствующий начальной дате.

n

Числовой объект. Число лет, добавляемых к дате. Десятичные числа обрабатываются как целые (округление).

Возвращает

Дата, полученная в результате добавления к начальной дате указанного числа лет.

Примеры

В следующих примерах к указанной дате добавляется некоторое число лет:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addYear( startDate, 1 ); // возвращает 31 декабря 2009 г.
endDate = BirtDateTime.addYear( startDate, -1 ); // возвращает 31 декабря 2007 г.

В следующем примере к каждому значению даты в поле HireDate добавляется 5 лет:

BirtDateTime.addYear( row["HireDate"], 5 )

BirtDateTime.day

Эта функция возвращает число в диапазоне от 1 до 31, представляющее день месяца для указанной даты. Например, если значение даты равно 2009-01-19, то функция возвращает 19.

Синтаксис

integer BirtDateTime.day( Date date )

Параметр

date

Объект Date. Объект Дата, из которого требуется получить день месяца.

Возвращает

Целое число, представляющее день месяца для указанной даты.

Примеры

В следующем примере возвращается день месяца для каждого значения в поле ShipDate:

BirtDateTime.day( row["ShipDate"] )

В следующем примере возвращается день месяца для текущей даты:

BirtDateTime.day( (BirtDateTime.today())

BirtDateTime.diffDay

Эта функция возвращает число дней между двумя датами. День вычисляется путем вычитания значения дня первой даты из значения дня второй даты. Например, если значение первой даты равно 2008-12-30 23:59:59, а второй - 2008-12-31 00:00:00, то функция возвращает 1 день, несмотря на то, что между этими двумя датами всего одна секунда.

Синтаксис

integer BirtDateTime.diffDay( Date date1, Date date2 )

Параметры

date1

Объект Дата, соответствующий началу интервала.

date2

Объект Дата, соответствующий окончанию интервала.

Возвращает

Integer. Число дней между двумя датами.

Примеры

В следующем примере возвращается число дней между указанными датами:

BirtDateTime.diffDay( "2009-01-01", "2009-04-15" ) // возвращает 104

В следующем примере возвращается число дней между текущей датой и окончанием 2009 года:

BirtDateTime.diffDay( BirtDateTime.today(), "2009-12-31" )

В следующем примере возвращается число дней между значениями в полях InvoiceDate и PaymentDate:

BirtDateTime.diffDay( row["InvoiceDate"], row["PaymentDate"] )

BirtDateTime.diffHour

Эта функция возвращает количество часов между двумя датами. Часы вычисляются путем вычитания значения часов первой даты из значения часов второй даты. Например, если значение первой даты равно 2009-01-31 1:30:00, а второй - 2009-01-31 2:00:00, то функция возвращает 1 час, несмотря на то, что между этими двумя датами всего 30 минут. Если для даты не указано значение времени, то данная функция в качестве значения времени примет полночь (00:00:00).

Синтаксис

integer BirtDateTime.diffHour( Date date1, Date date2 )

Параметры

date1

Объект Дата, соответствующий началу интервала.

date2

Объект Дата, соответствующий окончанию интервала.

Возвращает

Integer. Количество часов между двумя датами.

Примеры

В следующем примере возвращается количество часов между указанными датами:

BirtDateTime.diffHour( "2009-01-31 12:00:00", "2009-02-01 12:00:00")
// возвращает 24
BirtDateTime.diffHour( "2009-01-31", "2009-02-01 12:00:00")
// возвращает 36. Поскольку для первой даты не указано время, в качестве значения времени принимается полночь.

В следующем примере возвращается количество часов между текущей датой и временем и окончанием 2009 года:

BirtDateTime.diffHour( BirtDateTime.now(), "2009-12-31" );

В следующем примере возвращается количество часов между значениями в полях StartTime и FinishTime:

BirtDateTime.diffHour( row["StartTime"], row["FinishTime"] )

BirtDateTime.diffMinute

Эта функция возвращает количество минут между двумя датами. Минуты вычисляются путем вычитания значения минут первой даты из значения минут второй даты. Например, если значение первой даты равно 2009-01-31 1:30:59, а второй - 2009-01-31 1:31:00, то функция возвращает 1 минуту, несмотря на то, что между этими двумя датами всего одна секунда. Если для даты не указано значение времени, то данная функция в качестве значения времени примет полночь (00:00:00).

Синтаксис

integer BirtDateTime.diffMinute( Date date1, Date date2 )

Параметры

date1

Объект Дата, соответствующий началу интервала.

date2

Объект Дата, соответствующий окончанию интервала.

Возвращает

Integer. Количество минут между двумя датами.

Примеры

В следующем примере возвращается количество минут между указанными датами:

BirtDateTime.diffMinute( "2009-01-31 1:30:30", "2009-01-31 10:45:00")
// возвращает 555
BirtDateTime.diffMinute( "2009-01-31", "2009-01-31 12:00:00")
// возвращает 720. Поскольку для первой даты не указано время, в качестве значения времени принимается полночь.

В следующем примере возвращается количество минут между текущей датой и временем и началом 2010 года:

BirtDateTime.diffMinute( BirtDateTime.now(), "2010-01-01" )

В следующем примере возвращается количество минут между значениями в полях StartTime и FinishTime:

BirtDateTime.diffMinute( row["StartTime"], row["FinishTime"] )

BirtDateTime.diffMonth

Эта функция возвращает число месяцев между двумя датами. Месяц вычисляется путем вычитания значения месяца первой даты из значения месяца второй даты. Например, если значение первой даты равно 2009-01-31, а второй - 2009-02-01, то функция возвращает 1 месяц, несмотря на то, что между этими двумя датами всего один день.

Синтаксис

integer BirtDateTime.diffMonth( Date date1, Date date2 )

Параметры

date1

Объект Дата, соответствующий началу интервала.

date2

Объект Дата, соответствующий окончанию интервала.

Возвращает

Integer. Число месяцев между двумя датами.

Примеры

В следующем примере возвращается число месяцев между указанными датами:

BirtDateTime.diffMonth( "2009-01-31", "2009-04-15") // возвращает 3

В следующем примере возвращается число месяцев между текущей датой и началом 2010 года:

BirtDateTime.diffMonth( BirtDateTime.today(), "2010-01-01" );

В следующем примере возвращается число месяцев между значениями в полях ProjectStart и ProjectComplete:

BirtDateTime.diffMonth( row["ProjectStart"], row["ProjectComplete"] )

BirtDateTime.diffQuarter

Эта функция возвращает число кварталов между двумя датами. Квартал вычисляется путем вычитания значения месяца первой даты из значения месяца второй даты. Разница в 3 месяца составляет 1 квартал. Например, если значение первой даты равно 2009-01-31, а второй - 2009-07-01, то функция возвращает 2. Если значение первой даты равно 2009-01-01, а второй - 2009-09-30, функция также возвращает 2.

Синтаксис

integer BirtDateTime.diffQuarter( Date date1, Date date2 )

Параметры

date1

Объект Дата, соответствующий началу интервала.

date2

Объект Дата, соответствующий окончанию интервала.

Возвращает

Integer. Число кварталов между двумя датами.

Примеры

В следующем примере возвращается число кварталов между указанными датами:

BirtDateTime.diffQuarter( "2009-01-31", "2009-04-15") // возвращает 1

В следующем примере возвращается число кварталов между текущей датой и началом 2010 года:

BirtDateTime.diffQuarter( BirtDateTime.today(), "2010-01-01" );

В следующем примере возвращается число кварталов между значениями в полях ProjectStart и ProjectComplete:

BirtDateTime.diffQuarter( row["ProjectStart"], row["ProjectComplete"] )

BirtDateTime.diffSecond

Эта функция возвращает количество секунд между двумя датами. Если для даты не указано значение времени, то данная функция в качестве значения времени примет полночь (00:00:00).

Синтаксис

integer BirtDateTime.diffSecond( date1, date2 )

Параметры

date1

Объект Дата, соответствующий началу интервала.

date2

Объект Дата, соответствующий окончанию интервала.

Возвращает

Integer. Количество секунд между двумя датами.

Примеры

В следующем примере возвращается количество секунд между указанными датами:

BirtDateTime.diffSecond( "2009-01-31 11:30:30", "2009-01-31 12:00:00")
// возвращает 1770
BirtDateTime.diffSecond( "2009-01-31", "2009-01-31 1:00:00")
// возвращает 3600. Поскольку для первой даты не указано время, в качестве значения времени принимается полночь.

В следующем примере возвращается количество секунд между текущей датой и временем и началом 2010 года:

BirtDateTime.diffSecond( BirtDateTime.now(), "2010-01-01" )

В следующем примере возвращается количество секунд между значениями в полях StartTime и FinishTime:

BirtDateTime.diffSecond( row["StartTime"], row["FinishTime"] )

BirtDateTime.diffWeek

Эта функция возвращает число недель между двумя датами. Неделя вычисляется путем вычитания номера недели первой даты из номера недели второй даты. Например, если значение первой даты равно 2009-01-02 (первая неделя года), а второй - 2009-01-05 (вторая неделя года), то функция возвращает 1 неделю, несмотря на то, что между этими двумя датами всего три дня.

Синтаксис

integer BirtDateTime.diffWeek( Date date1, Date date2 )

Параметры

date1

Объект Дата, соответствующий началу интервала.

date2

Объект Дата, соответствующий окончанию интервала.

Возвращает

Integer. Число недель между двумя датами.

Примеры

В следующем примере возвращается число недель между указанными датами:

BirtDateTime.diffWeek( "2009-01-01", "2009-02-01") // возвращает 5

В следующем примере возвращается число недель между текущей датой и началом 2010 года:

BirtDateTime.diffWeek( BirtDateTime.today(), "2010-01-01" );

В следующем примере возвращается число недель между значениями в полях ProjectStart и ProjectComplete:

BirtDateTime.diffWeek( row["ProjectStart"], row["ProjectComplete"] )

BirtDateTime.diffYear

Эта функция возвращает число лет между двумя датами. Год вычисляется путем вычитания значения года первой даты из значения года второй даты. Например, если значение первой даты равно 2009-01-01, а второй - 2009-12-31, то функция возвращает 0. Если значение первой даты равно 2008-11-15, а второй - 2009-01-15, функция возвращает 1.

Синтаксис

integer BirtDateTime.diffYear( Date date1, Date date2 )

Параметры

date1

Объект Дата, соответствующий началу интервала.

date2

Объект Дата, соответствующий окончанию интервала.

Возвращает

Integer. Число лет между двумя датами.

Примеры

В следующем примере возвращается число лет между указанными датами:

BirtDateTime.diffYear( "2005-01-01", "2009-06-01") // возвращает 4

В следующем примере возвращается число лет между всеми значениями в поле HireDate и текущей датой:

BirtDateTime.diffYear( row["HireDate"], BirtDateTime.today() )

BirtDateTime.diffYear

Эта функция возвращает число лет между двумя датами. Год вычисляется путем вычитания значения года первой даты из значения года второй даты. Например, если значение первой даты равно 2009-01-01, а второй - 2009-12-31, то функция возвращает 0. Если значение первой даты равно 2008-11-15, а второй - 2009-01-15, функция возвращает 1.

Syntax

integer BirtDateTime.diffYear( Date date1, Date date2 )

Параметры

date1

Объект Дата, соответствующий началу интервала.

date2

Объект Дата, соответствующий окончанию интервала.

Возвращает

Integer. Число лет между двумя датами.

Примеры

В следующем примере возвращается число лет между указанными датами:

BirtDateTime.diffYear( "2005-01-01", "2009-06-01") // возвращает 4

В следующем примере возвращается число лет между всеми значениями в поле HireDate и текущей датой:

BirtDateTime.diffYear( row["HireDate"], BirtDateTime.today() )

BirtDateTime.firstDayOfMonth

Эта функция возвращает дату первого дня месяца, на который приходится входная дата.

Syntax

Date BirtDateTime.firstDayOfMonth( Date date)

Параметры

date

Объект Дата, из которого требуется получить месяц.

Возвращает

Объект Date. Первый день месяца для указанной даты.

Примеры

В следующем примере показаны значения месяца, возвращаемые для указанной даты:

BirtDateTime.firstDayOfMonth( "2009-02-15" ) // возвращает 2009-02-01

BirtDateTime.firstDayOfQuarter

Эта функция возвращает дату первого дня квартала, на который приходится входная дата.

Syntax

Date BirtDateTime.firstDayOfQuarter( Date date)

Параметры

date

Объект Дата, из которого требуется получить квартал.

Возвращает

Объект Date. Первый день квартала для указанной даты.

Примеры

В следующем примере показаны значения квартала, возвращаемые для указанной даты:

BirtDateTime.firstDayOfQuarter( "2009-02-15" ) // возвращает 2009-01-01

BirtDateTime.firstDayOfWeek

Эта функция возвращает дату первого дня недели, на которую приходится входная дата (всегда Воскресенье).

Syntax

Date BirtDateTime.firstDayOfWeek( Date date)

Параметры

date

Объект Дата, из которого требуется получить неделю.

Возвращает

Объект Date. Первый день недели для указанной даты.

Примеры

В следующем примере показаны значения недели, возвращаемые для указанной даты:

BirtDateTime.firstDayOfWeek( "2009-02-15" ) // возвращает 2009-02-15

BirtDateTime.firstDayOfYear

Эта функция возвращает дату первого дня года, на который приходится входная дата.

Syntax

Date BirtDateTime.firstDayOfYear( Date date)

Параметры

date

Объект Дата, из которого требуется получить год.

Возвращает

Объект Date. Первый день года для указанной даты.

Примеры

В следующем примере показаны значения года, возвращаемые для указанной даты:

BirtDateTime.firstDayOfYear( "2009-02-15" ) // returns 2009-01-01

BirtDateTime.month

Эта функция возвращает месяц указанной даты. В зависимости от заданного параметра option функция возвращает месяц в виде числа, полного названия месяца или сокращенного названия месяца. Именование месяца определяется локалью.

Syntax

string BirtDateTime.month( Date date, integer option )

Параметры

date

Объект Дата, из которого требуется получить месяц.

option

Integer. Необязательный атрибут. Число, представляющее формат возвращаемого месяца. Можно использовать одно из следующих значений:

*
*
*

Если этот параметр не задан, функция возвращает месяц в виде номера.

Возвращает

String. Месяц в указанной дате.

Примеры

В следующем примере показаны значения месяца, возвращаемые для указанной даты:

BirtDateTime.month( "2009-02-15" ) // возвращает 2
BirtDateTime.month( "2009-02-15", 2 ) // возвращает февраль
BirtDateTime.month( "2009-02-15", 3) // возвращает фев

В следующем примере возвращается месяц в текущей дате:

BirtDateTime.month( (BirtDateTime.today() )

BirtDateTime.now

Эта функция возвращает текущую дату и время, например: 2 фев 2009 14:05.

Синтаксис

Date BirtDateTime.now( )

Возвращает

Объект Date. Текущая дата и время.

Пример

В следующем примере возвращается количество часов между текущей датой и временем и Рождеством:

BirtDateTime.diffHour( BirtDateTime.now(), "2009-12-25" )

BirtDateTime.quarter

Эта функция возвращает число в диапазоне от 1 до 4, представляющее квартал, к которому относится указанная дата. Первый квартал начинается с 1 января.

Синтаксис

integer BirtDateTime.quarter( Date date )

Параметр

date

Объект Дата, из которого требуется получить номер квартала.

Возвращает

Integer. Номер квартала для указанной даты.

Примеры

В следующем примере показаны номера кварталов, возвращаемые для определенных дат:

BirtDateTime.quarter( "2009-02-15" ) // возвращает 1
BirtDateTime.quarter( "2009-07-10" ) // возвращает 3

В следующем примере возвращается номер квартала для каждого значения в поле CloseDate:

BirtDateTime.quarter( row["CloseDate"] )

В следующем примере возвращается номер квартала для текущей даты:

BirtDateTime.quarter( (BirtDateTime.today() )

BirtDateTime.today

Эта функция возвращает текущую дату со значением времени, соответствующим полуночи, например 2 февраля 2009 г., 00:00.

Синтаксис

Date BirtDateTime.today( )

Возвращает

Объект Date. Текущая дата со значением времени, соответствующим полночи.

Примеры

В следующем примере возвращается число дней между текущей датой и Рождеством:

BirtDateTime.diffDay( BirtDateTime.today(), "2009-12-25" )

В следующем примере возвращается число лет между всеми значениями в поле даты HireDate и текущей датой.

BirtDateTime.diffYear( [HireDate], BirtDateTime.today() )

BirtDateTime.week

Эта функция возвращает число в диапазоне от 1 до 52, представляющее номер недели для указанной даты.

Синтаксис

integer BirtDateTime.week( date )

Параметр

date

Объект Дата, из которого требуется получить номер недели.

Возвращает

Integer. Номер недели для указанной даты.

Примеры

В следующем примере показаны номера недель, возвращаемые для определенных дат:

BirtDateTime.week( "2009-02-15" ) // возвращает 8
BirtDateTime.week( "2009-10-12" ) // возвращает 42

В следующем примере возвращается номер недели для каждого значения в поле CloseDate:

BirtDateTime.week( row["CloseDate"] )

В следующем примере возвращается номер недели для текущей даты:

BirtDateTime.week( (BirtDateTime.today() )

BirtDateTime.weekDay

Эта функция возвращает день недели для указанной даты. В зависимости от заданного параметра option функция возвращает день недели в виде числа, полного названия недели или сокращенного названия недели. Именование дней недели определяется локалью.

Синтаксис

string BirtDateTime.weekDay( Date date, integer option )

Параметры

date

Объект Дата, из которого требуется получить день недели.

option

Integer. Необязательный атрибут. Число, представляющее формат возвращаемого значения. Можно использовать одно из следующих значений:

*
*
*
*
*

Если этот параметр не задан, функция использует значение 1.

Возвращает

String. День недели для указанной даты.

Примеры

В следующем примере показаны значения дня недели, возвращаемые для указанной даты:

BirtDateTime.weekDay( "2009-02-02" ) // возвращает 2
BirtDateTime.weekDay( "2009-02-02", 2 ) // возвращает 1
BirtDateTime.weekDay( "2009-02-02", 4 ) // возвращает понедельник

В следующем примере возвращается день недели для текущей даты:

BirtDateTime.weekDay( (BirtDateTime.today() )

BirtDateTime.year

Эта функция возвращает значение года указанной даты в виде четырехзначного числа. Например, если значение даты равно 2009-01-19, то функция возвращает 2009.

Синтаксис

integer BirtDateTime.year( date )

Параметр

date

Объект Дата, из которого требуется получить год.

Возвращает

Integer. Значение года указанной даты в виде четырехзначного числа.

Примеры

В следующем примере возвращается год для каждого значения в поле HireDate:

BirtDateTime.year( row["HireDate"] )

В следующем примере возвращается год для текущей даты:

BirtDateTime.year( (BirtDateTime.today())

(c) Copyright Actuate Corporation 2013