Anterior Avançar

Classe BirtDateTime

A classe BirtDateTime fornece funções para determinar a quantidade de tempo entre duas datas ou horas, para adicionar ou subtrair períodos de tempo e obter partes de uma data. Como os intervalos de data são apenas números, o aplicativo pode usar matemática normal entre eles: multiplicação, divisão, adição, subtração e assim por diante. Essa classe é estática. O aplicativo não pode criar instâncias da classe.

BirtDateTime.addDay

Esta função retorna uma nova data resultante da inclusão de um determinado número de dias em uma data. O número de dias a serem adicionados pode ser negativo. Neste caso, o resultado é como se o número fosse subtraído da data.

Sintaxe

Date BirtDateTime.addDay( Date date, Number n )

Parâmetros

data

Objeto de data. Um objeto de data que representa a data de início.

n

Objeto de número. O número de dias a ser incluído na data. Os decimais são tratados como números inteiros, arredondados para baixo para o número inteiro mais próximo.

Retornos

Objeto de data. Uma data resultante da inclusão do número especificado de dias na data de início.

Exemplos

O exemplo a seguir adiciona dias a uma data específica:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addDay( startDate, 1 ); // retorna Jan 01, 2009
endDate = BirtDateTime.addDay( startDate, -1 ); // retorna Dec 30, 2008

O exemplo a seguir adiciona 15 dias a cada valor de data contido no campo InvoiceDate:

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

BirtDateTime.addHour

Esta função retorna uma nova data resultante da inclusão de um determinado número de horas em uma data. O número de horas a serem adicionadas pode ser negativo. Neste caso, o resultado é como se o número fosse subtraído da data.

Sintaxe

Date BirtDateTime.addHour( Date date, Number n )

Parâmetros

data

Um objeto de data que representa a data de início. Se uma data de início não tiver um valor de hora, a função considerará o horário como sendo meia-noite (00:00:00).

n

Objeto de número. O número de horas a ser incluído na data.

Retornos

Objeto de data. Uma data resultante da inclusão do número especificado de horas na data de início.

Exemplos

O exemplo a seguir adiciona horas a uma data e hora específicas:

var startDate = "2008-12-31 15:00:00";
var endDate;
endDate = BirtDateTime.addHour( startDate, 8 ); // retorna Dec 31, 2008 11:00 PM
endDate = BirtDateTime.addHour( startDate, -8 ); // retorna Dec 31, 2008 7:00 AM

O exemplo a seguir adiciona 36 horas a cada valor de data contido no campo StartTime:

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

BirtDateTime.addMinute

Esta função retorna uma nova data resultante da inclusão de um determinado número de minutos em uma data. O número de minutos a serem adicionados pode ser negativo. Neste caso, o resultado é como se o número fosse subtraído da data.

Sintaxe

Date BirtDateTime.addMinute( Date date, Number n )

Parâmetros

data

Um objeto de data que representa a data de início. Se uma data de início não tiver um valor de hora, a função considerará o horário como sendo meia-noite (00:00:00).

n

Objeto de número. O número de minutos a ser incluído na data.

Retornos

Objeto de data. Uma data resultante da inclusão do número especificado de minutos na data de início.

Exemplos

O exemplo a seguir adiciona minutos a uma data e hora específicas:

var startDate = "2008-12-31 10:30:00";
var endDate;
endDate = BirtDateTime.addMinute( startDate, 45 );
// retorna Dec 31, 2008 11:15 AM
endDate = BirtDateTime.addMinute( startDate, -30 );
// retorna Dec 31, 2008 10:00 AM

O exemplo a seguir adiciona 15 minutos a cada valor de data contido no campo StartTime:

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

BirtDateTime.addMonth

Esta função retorna uma nova data resultante da inclusão de um determinado número de meses em uma data. O número de meses a serem somados pode ser negativo. Neste caso, o resultado é como se o número fosse subtraído da data.

Esta função sempre retorna uma data válida. Se necessário, a parte do dia da data resultante é ajustada para baixo para o último dia do mês resultante no ano resultante. Por exemplo, se você incluir 1 mês em 31 de janeiro de 2008, addMonth( ) retornará 29 de fevereiro de 2008 (2008 é um ano bissexto), não 31 de fevereiro de 2008.

Sintaxe

Date BirtDateTime.addMonth( Date date, Number n )

Parâmetros

data

Objeto de data. Um objeto de data que representa a data de início.

n

Objeto de número. O número de meses a ser incluído na data. Os decimais são tratados como números inteiros, arredondados para baixo.

Retornos

Objeto de data. Uma data resultante da inclusão do número especificado de meses na data de início.

Exemplos

O exemplo a seguir adiciona meses a uma data específica:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addMonth( startDate, 1 ); // retorna Jan 31, 2009
endDate = BirtDateTime.addMonth( startDate, -1 ); // retorna Nov 30, 2008
endDate = BirtDateTime.addMonth( startDate, 2 ); // retorna Feb 28, 2009

O exemplo a seguir inclui 10 meses em cada valor de data no campo InvoiceDate:

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

BirtDateTime.addQuarter

Esta função retorna uma nova data resultante da inclusão de um determinado número de trimestres em uma data. Um trimestre é igual a três meses. Por exemplo, se você incluir 2 trimestres em 10 de setembro de 2008, a função retornará 10 de março de 2009. O número de trimestres a serem adicionados pode ser negativo. Neste caso, o resultado é como se o número fosse subtraído da data.

Sintaxe

Date BirtDateTime.addQuarter( Date date, Number n )

Parâmetros

data

Um objeto de data que representa a data de início.

n

Objeto de número. O número de trimestres a ser incluído na data.

Retornos

Objeto de data. Uma data resultante da inclusão do número especificado de trimestres na data de início.

Exemplos

O exemplo a seguir adiciona trimestres a uma data específica:

var startDate = "2008-12-15";
var endDate;
endDate = BirtDateTime.addQuarter( startDate, 1 ); //returns Mar 15, 2009
endDate = BirtDateTime.addQuarter( startDate, -2 ); //returns Jun 15, 2008

O exemplo a seguir inclui 2 trimestres em cada valor de data no campo ForecastClosing:

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

BirtDateTime.addSecond

Esta função retorna uma nova data resultante da inclusão de um determinado número de segundos em uma data. O número de segundos a serem adicionados pode ser negativo. Neste caso, o resultado é como se o número fosse subtraído da data.

Sintaxe

Date BirtDateTime.addSecond( Date date, Number n )

Parâmetros

data

Um objeto de data que representa a data de início. Se uma data de início não tiver um valor de hora, a função considerará o horário como sendo meia-noite (00:00:00).

n

Objeto de número. O número de segundos a ser incluído na data.

Retornos

Objeto de data. O resultado da inclusão do número especificado de segundos na data de início.

Exemplos

O exemplo a seguir adiciona segundos a uma data e hora específicas:

var startDate = "2008-12-31 10:30:00";
var endDate;
endDate = BirtDateTime.addSecond( startDate, 10000 );
// retorna Dec 31, 2008 1:16:40 PM
endDate = BirtDateTime.addSecond( startDate, -10000 );
// retorna Dec 31, 2008 7:43:20 AM

O exemplo a seguir inclui 6000 segundos em cada valor de data no campo StartTime:

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

BirtDateTime.addWeek

Esta função retorna uma nova data resultante da inclusão de um determinado número de semanas em uma data. O número de semanas a serem adicionadas pode ser negativo. Neste caso, o resultado é como se o número fosse subtraído da data.

Sintaxe

Date BirtDateTime.addWeek( Date date, Number n )

Parâmetros

data

Um objeto de data que representa a data de início.

n

Objeto de Número. O número de semanas a ser incluído na data.

Retornos

Objeto de data. Uma data resultante da inclusão do número especificado de semanas na data de início.

Exemplos

O exemplo a seguir adiciona semanas a uma data específica:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addWeek( startDate, 1 ); // retorna Jan 07, 2009
endDate = BirtDateTime.addWeek( startDate, -1 ); // retorna Dec 24, 2008

O exemplo a seguir adiciona 2 semanas a cada valor de data contido no campo InvoiceDate:

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

BirtDateTime.addYear

Esta função retorna uma nova data resultante da inclusão de um determinado número de anos em uma data. O número de anos a serem adicionados pode ser negativo. Neste caso, o resultado é como se o número fosse subtraído da data.

Sintaxe

Date BirtDateTime.addYear( Date date, Number n )

Parâmetros

data

Um objeto de data que representa a data de início.

n

Objeto de número. O número de anos a ser incluído na data. Os decimais são tratados como números inteiros, arredondados para baixo.

Retornos

Uma data que resulta da adição do número especificado de anos à data de início.

Exemplos

O exemplo a seguir adiciona anos a uma data específica:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addYear( startDate, 1 ); // retorna Dec 31, 2009
endDate = BirtDateTime.addYear( startDate, -1 ); // retorna Dec 31, 2007

O exemplo a seguir adiciona 5 anos a cada valor de data contido no campo HireDate:

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

BirtDateTime.day

Esta função retorna um número de 1 a 31 que representa o dia do mês para uma determinada data. Por exemplo, se a data for 2009-01-19, a função retornará 19.

Sintaxe

integer BirtDateTime.day( Date date )

Parâmetro

data

Objeto de data. Um objeto de data do qual se obtém o dia.

Retornos

Um número inteiro que representa o dia do mês para uma determinada data.

Exemplos

O exemplo a seguir retorna o dia do mês para cada valor no campo ShipDate:

BirtDateTime.day( row["ShipDate"] )

O exemplo a seguir retorna o dia do mês para a data atual:

BirtDateTime.day( (BirtDateTime.today())

BirtDateTime.diffDay

Esta função retorna o número de dias entre duas datas. Um dia é calculado subtraindo o valor de dia da primeira data do valor de dia da segunda data. Por exemplo, se a primeira data for 2008-12-30 23:59:59 e a segunda data for 2008-12-31 00:00:00, a função retornará 1 dia, mesmo que apenas um segundo separe as duas datas.

Sintaxe

integer BirtDateTime.diffDay( Date date1, Date date2 )

Parâmetros

date1

Um objeto de data que representa o início do intervalo de tempo.

date2

Um objeto de data que representa o fim do intervalo de tempo.

Retornos

Número Inteiro. O número de dias entre duas datas.

Exemplos

O exemplo a seguir retorna o número de dias entre datas específicas:

BirtDateTime.diffDay( "2009-01-01", "2009-04-15" ) // retorna 104

O exemplo a seguir retorna o número de dias da data atual ao final de 2009:

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

O exemplo a seguir retorna o número de dias entre valores nos campos InvoiceDate e PaymentDate:

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

BirtDateTime.diffHour

Esta função retorna o número de horas entre duas datas. Uma hora é calculada subtraindo o valor de hora da primeira data do valor de hora da segunda data. Por exemplo, se a primeira data for 2009-01-31 1:30:00 e a segunda data for 2009-01-31 2:00:00, a função retornará 1 hora, embora apenas 30 minutos separe as duas datas. Se uma data não tiver um valor de hora, a função considerará o horário como sendo meia-noite (00:00:00).

Sintaxe

integer BirtDateTime.diffHour( Date date1, Date date2 )

Parâmetros

date1

Um objeto de data que representa o início do intervalo de tempo.

date2

Um objeto de data que representa o fim do intervalo de tempo.

Retornos

Número Inteiro. O número de horas entre duas datas.

Exemplos

O exemplo a seguir retorna o número de horas entre datas específicas:

BirtDateTime.diffHour( "2009-01-31 12:00:00", "2009-02-01 12:00:00")
// retorna 24
BirtDateTime.diffHour( "2009-01-31", "2009-02-01 12:00:00")
// retorna 36. Como a primeira data não tem um horário, assume-se que seja meia-noite.

O exemplo a seguir retorna o número de horas da data e hora atuais ao final de 2009:

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

O exemplo a seguir retorna o número de horas entre valores nos campos StartTime e FinishTime:

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

BirtDateTime.diffMinute

Esta função retorna o número de minutos entre duas datas. Um minuto é calculado subtraindo o valor de minuto da primeira data do valor de minuto da segunda data. Por exemplo, se a primeira data for 2009-01-31 1:30:59 e a segunda data for 2009-01-31 1:31:00, a função retornará 1 minuto, embora apenas 1 segundo separe as duas datas. Se uma data não tiver um valor de hora, a função considerará o horário como sendo meia-noite (00:00:00).

Sintaxe

integer BirtDateTime.diffMinute( Date date1, Date date2 )

Parâmetros

date1

Um objeto de data que representa o início do intervalo de tempo.

date2

Um objeto de data que representa o fim do intervalo de tempo.

Retornos

Número Inteiro. O número de minutos entre duas datas.

Exemplos

O exemplo a seguir retorna o número de minutos entre datas específicas:

BirtDateTime.diffMinute( "2009-01-31 1:30:30", "2009-01-31 10:45:00")
// retorna 555
BirtDateTime.diffMinute( "2009-01-31", "2009-01-31 12:00:00")
// retorna 720. Como a primeira data não tem um horário, assume-se que seja meia-noite.

O exemplo a seguir retorna o número de minutos da data e hora atuais ao início de 2010:

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

O exemplo a seguir retorna o número de minutos entre valores nos campos StartTime e FinishTime:

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

BirtDateTime.diffMonth

Esta função retorna o número de meses entre duas datas. Um mês é calculado subtraindo o valor de mês da primeira data do valor de mês da segunda data. Por exemplo, se a primeira data for 2009-01-31 e a segunda data for 2009-02-01, a função retornará 1 mês, mesmo que apenas um dia separe as duas datas.

Sintaxe

integer BirtDateTime.diffMonth( Date date1, Date date2 )

Parâmetros

date1

Um objeto de data que representa o início do intervalo de tempo.

date2

Um objeto de data que representa o fim do intervalo de tempo.

Retornos

Número Inteiro. O número de meses entre duas datas.

Exemplos

O exemplo a seguir retorna o número de meses entre datas específicas:

BirtDateTime.diffMonth( "2009-01-31", "2009-04-15") // retorna 3

O exemplo a seguir retorna o número de meses da data atual ao início de 2010:

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

O exemplo a seguir retorna o número de meses entre valores nos campos ProjectStart e ProjectComplete:

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

BirtDateTime.diffQuarter

Esta função retorna o número de trimestres entre duas datas. Um trimestre é calculado subtraindo o valor de mês da primeira data do valor de mês da segunda data. Uma diferença de 3 meses é igual a 1 trimestre. Por exemplo, se a primeira data for 2009-01-31 e a segunda data for 2009-07-01, a função retornará 2. Se a primeira data for 2009-01-01 e a segunda data for 2009-09-30, a função também retornará 2.

Sintaxe

integer BirtDateTime.diffQuarter( Date date1, Date date2 )

Parâmetros

date1

Um objeto de data que representa o início do intervalo de tempo.

date2

Um objeto de data que representa o fim do intervalo de tempo.

Retornos

Número Inteiro. O número de trimestres entre duas datas.

Exemplos

O exemplo a seguir retorna o número de trimestres entre datas específicas:

BirtDateTime.diffQuarter( "2009-01-31", "2009-04-15") // retorna 1

O exemplo a seguir retorna o número de trimestres da data atual ao início de 2010:

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

O exemplo a seguir retorna o número de trimestres entre valores nos campos ProjectStart e ProjectComplete:

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

BirtDateTime.diffSecond

Esta função retorna o número de segundos entre duas datas. Se uma data não tiver um valor de hora, a função considerará o horário como sendo meia-noite (00:00:00).

Sintaxe

integer BirtDateTime.diffSecond( date1, date2 )

Parâmetros

date1

Um objeto de data que representa o início do intervalo de tempo.

date2

Um objeto de data que representa o fim do intervalo de tempo.

Retornos

Número Inteiro. O número de segundos entre duas datas.

Exemplos

O exemplo a seguir retorna o número de segundos entre datas específicas:

BirtDateTime.diffSecond( "2009-01-31 11:30:30", "2009-01-31 12:00:00")
// retorna 1770
BirtDateTime.diffSecond( "2009-01-31", "2009-01-31 1:00:00")
// retorna 3600. Como a primeira data não tem um horário, assume-se que seja meia-noite.

O exemplo a seguir retorna o número de segundos da data e hora atuais ao início de 2010:

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

O exemplo a seguir retorna o número de segundos entre valores nos campos StartTime e FinishTime:

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

BirtDateTime.diffWeek

Esta função retorna o número de semanas entre duas datas. Uma semana é calculada subtraindo o número da semana da primeira data do número da semana da segunda data. Por exemplo, se a primeira data for 2009-01-02 (semana 1 do ano) e a segunda data for 2009-01-05 (semana 2 do ano), a função retornará 1 semana, mesmo que apenas três dias separem as duas datas.

Sintaxe

integer BirtDateTime.diffWeek( Date date1, Date date2 )

Parâmetros

date1

Um objeto de data que representa o início do intervalo de tempo.

date2

Um objeto de data que representa o fim do intervalo de tempo.

Retornos

Número Inteiro. O número de semanas entre duas datas.

Exemplos

O exemplo a seguir retorna o número de semanas entre datas específicas:

BirtDateTime.diffWeek( "2009-01-01", "2009-02-01") // retorna 5

O exemplo a seguir retorna o número de semanas da data atual ao início de 2010:

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

O exemplo a seguir retorna o número de semanas entre valores nos campos ProjectStart e ProjectComplete:

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

BirtDateTime.diffYear

Esta função retorna o número de anos entre duas datas. Um ano é calculado subtraindo o valor de ano da primeira data do valor de ano da segunda data. Por exemplo, se a primeira data for 2009-01-01 e a segunda data for 2009-12-31, a função retornará 0. Se a primeira data for 2008-11-15 e a segunda data for 2009-01-15, a função retornará 1.

Sintaxe

integer BirtDateTime.diffYear( Date date1, Date date2 )

Parâmetros

date1

Um objeto de data que representa o início do intervalo de tempo.

date2

Um objeto de data que representa o fim do intervalo de tempo.

Retornos

Número Inteiro. O número de anos entre duas datas.

Exemplos

O exemplo a seguir retorna o número de anos entre datas específicas:

BirtDateTime.diffYear( "2005-01-01", "2009-06-01") // retorna 4

O exemplo a seguir retorna o número de anos entre cada valor no campo HireDate e a data atual:

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

BirtDateTime.diffYear

Esta função retorna o número de anos entre duas datas. Um ano é calculado subtraindo o valor de ano da primeira data do valor de ano da segunda data. Por exemplo, se a primeira data for 2009-01-01 e a segunda data for 2009-12-31, a função retornará 0. Se a primeira data for 2008-11-15 e a segunda data for 2009-01-15, a função retornará 1.

Sintaxe

integer BirtDateTime.diffYear( Date date1, Date date2 )

Parâmetros

date1

Um objeto de data que representa o início do intervalo de tempo.

date2

Um objeto de data que representa o fim do intervalo de tempo.

Retornos

Número Inteiro. O número de anos entre duas datas.

Exemplos

O exemplo a seguir retorna o número de anos entre datas específicas:

BirtDateTime.diffYear( "2005-01-01", "2009-06-01") // retorna 4

O exemplo a seguir retorna o número de anos entre cada valor no campo HireDate e a data atual:

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

BirtDateTime.firstDayOfMonth

Esta função retorna a data para o primeiro dia do mês em que cai a data de entrada.

Sintaxe

Date BirtDateTime.firstDayOfMonth( Date date)

Parâmetros

data

Um objeto de data do qual obter o mês.

Retornos

Objeto de data. O primeiro dia do mês para uma determinada data.

Exemplos

O exemplo a seguir mostra os valores de mês retornados para uma data específica:

BirtDateTime.firstDayOfMonth( "2009-02-15" ) // retorna 2009-02-01

BirtDateTime.firstDayOfQuarter

Esta função retorna a data para o primeiro dia do trimestre em que cai a data de entrada.

Sintaxe

Date BirtDateTime.firstDayOfQuarter( Date date)

Parâmetros

data

Um objeto de data do qual obter o trimestre.

Retornos

Objeto de data. O primeiro dia do trimestre para uma determinada data.

Exemplos

O exemplo a seguir mostra os valores de trimestre retornados para uma data específica:

BirtDateTime.firstDayOfQuarter( "2009-02-15" ) // retorna 2009-01-01

BirtDateTime.firstDayOfWeek

Esta função retorna a data para o primeiro dia da Semana em que cai a data de entrada, que é sempre um domingo.

Sintaxe

Date BirtDateTime.firstDayOfWeek( Date date)

Parâmetros

data

Um objeto de data do qual obter a Semana.

Retornos

Objeto de data. O primeiro dia da Semana para uma determinada data.

Exemplos

O exemplo a seguir mostra os valores de Semana retornados para uma data específica:

BirtDateTime.firstDayOfWeek( "2009-02-15" ) // retorna 2009-02-15

BirtDateTime.firstDayOfYear

Esta função retorna a data para o primeiro dia do Ano em que cai a data de entrada.

Sintaxe

Date BirtDateTime.firstDayOfYear( Date date)

Parâmetros

data

Um objeto de data do qual obter o Ano.

Retornos

Objeto de data. O primeiro dia do Ano para uma determinada data.

Exemplos

O exemplo a seguir mostra os valores de Ano retornados para uma data específica:

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

BirtDateTime.month

Esta função retorna o mês para uma data específica. Dependendo da opção especificada, a função retorna o mês como um número, o nome completo do mês ou o nome abreviado do mês. O nome do mês é específico do código de idioma.

Sintaxe

string BirtDateTime.month( Date date, integer option )

Parâmetros

data

Um objeto de data do qual obter o mês.

option

Número Inteiro. Opcional. Um número que representa o formato do mês a ser retornado. Use um dos seguintes valores:

*
*
*

Se você omitir este argumento, a função retornará o mês como um número.

Retornos

Sequência. O mês para uma determinada data.

Exemplos

O exemplo a seguir mostra os valores de mês retornados para uma data específica:

BirtDateTime.month( "2009-02-15" ) // retorna 2
BirtDateTime.month( "2009-02-15", 2 ) // retorna February
BirtDateTime.month( "2009-02-15", 3) // retorna Feb

O exemplo a seguir retorna o mês para a data atual:

BirtDateTime.month( (BirtDateTime.today() )

BirtDateTime.now

Esta função retorna a data e hora atuais, por exemplo, Feb 2, 2009 2:05 PM.

Sintaxe

Date BirtDateTime.now( )

Retornos

Objeto de data. A data e hora atuais.

Exemplo

O exemplo a seguir retorna o número de horas da data e hora atuais até o Natal:

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

BirtDateTime.quarter

Esta função retorna um número de 1 a 4 que representa o trimestre em que cai uma determinada data. O primeiro trimestre começa em 1 de janeiro.

Sintaxe

integer BirtDateTime.quarter( Date date )

Parâmetro

data

Um objeto de data do qual obter o número do trimestre.

Retornos

Número Inteiro. O número do trimestre para uma determinada data.

Exemplos

O exemplo a seguir mostra os números de trimestres retornados para datas específicas:

BirtDateTime.quarter( "2009-02-15" ) // retorna 1
BirtDateTime.quarter( "2009-07-10" ) // retorna 3

O exemplo a seguir retorna o número de trimestre para cada valor no campo CloseDate:

BirtDateTime.quarter( row["CloseDate"] )

O exemplo a seguir retorna o número do trimestre para a data atual:

BirtDateTime.quarter( (BirtDateTime.today() )

BirtDateTime.today

Esta função retorna a data atual que inclui um valor de hora de meia-noite, por exemplo, 2 de fevereiro de 2009 12:00 AM.

Sintaxe

Date BirtDateTime.today( )

Retornos

Objeto de data. A data atual com um valor de hora de meia-noite.

Exemplos

O exemplo a seguir retorna o número de dias da data atual até o Natal:

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

O exemplo a seguir calcula o número de anos a partir de cada valor no campo de dados HireDate até a data atual.

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

BirtDateTime.week

Esta função retorna um número de 1 a 52 que representa o número da semana para uma determinada data.

Sintaxe

integer BirtDateTime.week( date )

Parâmetro

data

Um objeto de data do qual obter o número da semana.

Retornos

Número Inteiro. O número da semana para uma determinada data.

Exemplos

O exemplo a seguir mostra os números de semana retornados para datas específicas:

BirtDateTime.week( "2009-02-15" ) // retorna 8
BirtDateTime.week( "2009-10-12" ) // retorna 42

O exemplo a seguir retorna o número da semana para cada valor no campo CloseDate:

BirtDateTime.week( row["CloseDate"] )

O exemplo a seguir retorna o número de semana para a data atual:

BirtDateTime.week( (BirtDateTime.today() )

BirtDateTime.weekDay

Esta função retorna o dia da semana para uma data específica. Dependendo da opção especificada, a função retorna o dia da semana como um número, o nome completo do dia da semana ou o nome abreviado do dia da semana. O nome de dia da semana é específico do código de idioma.

Sintaxe

string BirtDateTime.weekDay( Date date, integer option )

Parâmetros

data

Um objeto de data do qual se obtém o dia da semana.

option

Número Inteiro. Opcional. Um número que representa o formato a ser retornado. Use um dos seguintes valores:

*
*
*
*
*

Se você omitir este argumento, a função assumirá a opção 1.

Retornos

Sequência. O dia da semana para uma determinada data.

Exemplos

O exemplo a seguir mostra os valores de dia da semana retornados para uma data específica:

BirtDateTime.weekDay( "2009-02-02" ) // retorna 2
BirtDateTime.weekDay( "2009-02-02", 2 ) // retorna 1
BirtDateTime.weekDay( "2009-02-02", 4 ) // retorna Monday

O exemplo a seguir retorna o dia da semana para a data atual:

BirtDateTime.weekDay( (BirtDateTime.today() )

BirtDateTime.year

Esta função retorna o valor de ano de quatro dígitos para uma data específica. Por exemplo, se a data for 2009-01-19, a função retornará 2009.

Sintaxe

integer BirtDateTime.year( date )

Parâmetro

data

Um objeto de data do qual obter o ano.

Retornos

Número Inteiro. O valor de ano de quatro dígitos para uma determinada data.

Exemplos

O exemplo a seguir retorna o ano para cada valor no campo HireDate:

BirtDateTime.year( row["HireDate"] )

O exemplo a seguir retorna o ano para a data atual:

BirtDateTime.year( (BirtDateTime.today())

(c) Copyright Actuate Corporation 2013