Anterior Seguinte

Classe BirtDateTime

A classe BirtDateTime fornece funções para determinar a quantidade de tempo entre duas datas ou horas, bem como para adicionar ou subtrair intervalos de tempo e obter partes de uma data. Visto que os intervalos de datas são simplesmente números, a aplicação pode aplicar a matemática normal nos mesmos: multiplicação, divisão, soma, subtracção e assim sucessivamente. Esta classe é estática. A aplicação não pode criar ocorrências da classe.

BirtDateTime.addDay

Esta função devolve uma nova data que é o resultado da adição de um determinado número de dias à data inicial. O número de dias a adicionar pode ser negativo. Neste caso, o resultado é como se esse número tivesse sido subtraído à data.

Sintaxe

Date BirtDateTime.addDay( Date date, Number n )

Parâmetros

date

Objecto Date. Um objecto de data que representa a data de início.

n

Objecto Number. O número de dias a adicionar à data. Os decimais são considerados como inteiros, arredondados por defeito para o inteiro mais próximo.

Devoluções

Objecto Date. Uma data que resulta da adição do número especificado de dias à data inicial.

Exemplos

O exemplo seguinte adiciona dias à data específica:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addDay( startDate, 1 ); // devolve 01 de Janeiro de 2009
endDate = BirtDateTime.addDay( startDate, -1 ); // devolve 30 de Dezembro de 2008

O exemplo seguinte adiciona 15 dias a cada valor de data no campo InvoiceDate (Data de factura):

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

BirtDateTime.addHour

Esta função devolve uma nova data que é o resultado da adição de um determinado número de horas a uma data. O número de horas a adicionar pode ser negativo. Neste caso, o resultado é como se esse número tivesse sido subtraído à data.

Sintaxe

Date BirtDateTime.addHour( Date date, Number n )

Parâmetros

date

Um objecto de data que representa a data de início. Se uma data de início não possuir um valor de hora, a função parte do princípio que a hora é meia-noite (00h00m00s).

n

Objecto Number. O número de horas a adicionar à data.

Devoluções

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

Exemplos

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

var startDate = "2008-12-31 15:00:00";
var endDate;
endDate = BirtDateTime.addHour( startDate, 8 ); // devolve 31 de Dezembro de 2008, 23h00m
endDate = BirtDateTime.addHour( startDate, -8 ); // devolve 31 de Dezembro de 2008, 07h00m

O exemplo seguinte adiciona 36 horas a cada valor de data no campo StartTime (Hora de início):

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

BirtDateTime.addMinute

Esta função devolve uma nova data que é o resultado da adição de um determinado número de minutos a uma data. O número de minutos a adicionar pode ser negativo. Neste caso, o resultado é como se esse número tivesse sido subtraído à data.

Sintaxe

Date BirtDateTime.addMinute( Date date, Number n )

Parâmetros

date

Um objecto de data que representa a data de início. Se uma data de início não possuir um valor de hora, a função parte do princípio que a hora é meia-noite (00h00m00s).

n

Objecto Number. O número de minutos a adicionar à data.

Devoluções

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

Exemplos

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

var startDate = "2008-12-31 10:30:00";
var endDate;
endDate = BirtDateTime.addMinute( startDate, 45 );
// devolve 31 de Dezembro de 2008, 11h15m
endDate = BirtDateTime.addMinute( startDate, -30 );
// devolve 31 de Dezembro de 2008, 10h00m

O exemplo seguinte adiciona 15 minutos a cada valor de data no campo StartTime (Hora de início):

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

BirtDateTime.addMonth

Esta função devolve uma nova data que é o resultado da adição de um determinado número de meses a uma data. O número de meses a adicionar pode ser negativo. Neste caso, o resultado é como se esse número tivesse sido subtraído à data.

Esta função devolve sempre uma data válida. Caso seja necessário, o dia da data resultante é ajustado para o último dia do mês resultante no ano resultante. Por exemplo, se adicionar 1 mês a 31 de Janeiro de 2008, addMonth( ) devolve 29 de Fevereiro de 2008 (2008 é um ano bissexto) e não 31 de Fevereiro de 2008.

Sintaxe

Date BirtDateTime.addMonth( Date date, Number n )

Parâmetros

date

Objecto Date. Um objecto de data que representa a data de início.

n

Objecto Number. O número de meses a adicionar à data. Os decimais são considerados como inteiros, arredondados por defeito.

Devoluções

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

Exemplos

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

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addMonth( startDate, 1 ); // devolve 31 de Janeiro de 2009
endDate = BirtDateTime.addMonth( startDate, -1 ); // devolve 30 de Novembro de 2008
endDate = BirtDateTime.addMonth( startDate, 2 ); // devolve 28 de Fevereiro de 2009

O exemplo seguinte adiciona 10 meses a cada valor de data no campo InvoiceDate (Data de factura):

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

BirtDateTime.addQuarter

Esta função devolve uma nova data que é o resultado da adição de um determinado número de trimestres a uma data. Um trimestre é equivalente a três meses. Por exemplo, se adicionar 2 trimestres a 10 de Setembro de 2008, a função devolve 10 de Março de 2009. O número de trimestres a adicionar pode ser negativo. Neste caso, o resultado é como se esse número tivesse sido subtraído à data.

Sintaxe

Date BirtDateTime.addQuarter( Date date, Number n )

Parâmetros

date

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

n

Objecto Number. O número de trimestres a adicionar à data.

Devoluções

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

Exemplos

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

var startDate = "2008-12-15";
var endDate;
endDate = BirtDateTime.addQuarter( startDate, 1 ); // devolve 15 de Março de 2009
endDate = BirtDateTime.addQuarter( startDate, -2 ); // devolve 15 de Junho de 2008

O exemplo seguinte adiciona 2 trimestres a cada valor de data no campo ForecastClosing:

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

BirtDateTime.addSecond

Esta função devolve uma nova data que é o resultado da adição de um determinado número de segundos a uma data. O número de segundos a adicionar pode ser negativo. Neste caso, o resultado é como se esse número tivesse sido subtraído à data.

Sintaxe

Date BirtDateTime.addSecond( Date date, Number n )

Parâmetros

date

Um objecto de data que representa a data de início. Se uma data de início não possuir um valor de hora, a função parte do princípio que a hora é meia-noite (00h00m00s).

n

Objecto Number. O número de segundos a adicionar à data.

Devoluções

Objecto data. O resultado da adição do número especificado de segundos à data inicial.

Exemplos

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

var startDate = "2008-12-31 10:30:00";
var endDate;
endDate = BirtDateTime.addSecond( startDate, 10000 );
// devolve 31 de Dezembro de 2008, 13h16m40s
endDate = BirtDateTime.addSecond( startDate, -10000 );
// devolve 31 de Dezembro de 2008, 07h43m20s

O exemplo seguinte adiciona 6000 segundos a cada valor de data no campo StartTime (Hora de início):

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

BirtDateTime.addWeek

Esta função devolve uma nova data que é o resultado da adição de um determinado número de semanas a uma data. O número de semanas a adicionar pode ser negativo. Neste caso, o resultado é como se esse número tivesse sido subtraído à data.

Sintaxe

Date BirtDateTime.addWeek( Date date, Number n )

Parâmetros

date

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

n

Object Number. O número de semanas a adicionar à data.

Devoluções

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

Exemplos

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

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addWeek( startDate, 1 ); // devolve 07 de Janeiro de 2009
endDate = BirtDateTime.addWeek( startDate, -1 ); // devolve 24 de Dezembro de 2008

O exemplo seguinte adiciona 2 semanas a cada valor de data no campo InvoiceDate (Data de factura):

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

BirtDateTime.addYear

Esta função devolve uma nova data que é o resultado da adição de um determinado número de anos a uma data. O número de anos a adicionar pode ser negativo. Neste caso, o resultado é como se esse número tivesse sido subtraído à data.

Sintaxe

Date BirtDateTime.addYear( Date date, Number n )

Parâmetros

date

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

n

Objecto Number. O número de anos a adicionar à data. Os decimais são considerados como inteiros, arredondados por defeito.

Devoluções

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

Exemplos

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

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

O exemplo seguinte adiciona 5 anos a cada valor de data no campo HireDate (Data de contratação):

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

BirtDateTime.day

Esta função devolve um número entre 1 e 31 que representa o dia do mês de uma determinada data. Por exemplo, caso a data seja 2009-01-19, a função devolve 19.

Sintaxe

integer BirtDateTime.day( Date date )

Parâmetro

date

Objecto Date. Um objecto de data do qual pretende obter o dia.

Devoluções

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

Exemplos

O seguinte exemplo devolve o dia do mês para cada valor no campo ShipdDate (Data de envio):

BirtDateTime.day( row["ShipDate"] )

O exemplo seguinte devolve o dia do mês da data actual:

BirtDateTime.day( (BirtDateTime.today())

BirtDateTime.diffDay

Esta função devolve o número de dias entre duas datas. Um dia é calculado subtraindo o valor do dia da primeira data do valor do dia da segunda data. Por exemplo, se a primeira data for 2008-12-30 23h59m59s e a segunda data for 2008-12-31 00h00m00s, a função devolve 1 dia, apesar das duas datas estarem separadas por apenas um segundo.

Sintaxe

integer BirtDateTime.diffDay( Date date1, Date date2 )

Parâmetros

date1

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

date2

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

Devoluções

Integer. O número de dias entre duas datas.

Exemplos

O exemplo seguinte devolve o número de dias entre datas específicas:

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

O exemplo seguinte devolve o número de dias desde a data actual até ao final de 2009:

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

O exemplo seguinte devolve o número de dias entre valores nos campos InvoiceDate (Data de factura) e PaymentDate (Data de pagamento):

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

BirtDateTime.diffHour

Esta função devolve o número de horas entre duas datas. Uma hora é calculada subtraindo o valor da hora da primeira data do valor da hora da segunda data. Por exemplo, se a primeira data for 2009-01-31 01h30m00s e a segunda data for 2009-01-31 02h00m00s, a função devolve 1 hora, apesar das duas datas estarem separadas por apenas 30 minutos. Se uma data não possuir um valor de hora, a função parte do princípio que a hora é meia-noite (00h00m00s).

Sintaxe

integer BirtDateTime.diffHour( Date date1, Date date2 )

Parâmetros

date1

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

date2

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

Devoluções

Integer. O número de horas entre duas datas.

Exemplos

O exemplo seguinte devolve o número de horas entre datas específicas:

BirtDateTime.diffHour( "2009-01-31 12:00:00", "2009-02-01 12:00:00")
// devolve 24
BirtDateTime.diffHour( "2009-01-31", "2009-02-01 12:00:00")
// devolve 36. Dado que a primeira data não tem uma hora, é utilizada meia-noite.

O exemplo seguinte devolve o número de horas desde a data e hora actuais até ao final de 2009:

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

O exemplo seguinte devolve o número de horas entre valores nos campos StartTime (Hora de início) e FinishTime (Hora de conclusão):

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

BirtDateTime.diffMinute

Esta função devolve o número de minutos entre duas datas. Um minuto é calculado subtraindo o valor do minuto da primeira data do valor do minuto da segunda data. Por exemplo, se a primeira data for 2009-01-31 01h30m59s e a segunda data for 2009-01-31 01h31m00s, a função devolve 1 minuto, apesar das duas datas estarem separadas por apenas um segundo. Se uma data não possuir um valor de hora, a função parte do princípio que a hora é meia-noite (00h00m00s).

Sintaxe

integer BirtDateTime.diffMinute( Date date1, Date date2 )

Parâmetros

date1

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

date2

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

Devoluções

Integer. O número de minutos entre duas datas.

Exemplos

O exemplo seguinte devolve o número de minutos entre datas específicas:

BirtDateTime.diffMinute( "2009-01-31 1:30:30", "2009-01-31 10:45:00")
// devolve 555
BirtDateTime.diffMinute( "2009-01-31", "2009-01-31 12:00:00")
// devolve 720. Dado que a primeira data não tem uma hora, é utilizada meia-noite.

O exemplo seguinte devolve o número de minutos desde a data e hora actuais até ao início de 2010:

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

O exemplo seguinte devolve o número de minutos entre valores nos campos StartTime (Hora de início) e FinishTime (Hora de conclusão):

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

BirtDateTime.diffMonth

Esta função devolve o número de meses entre duas datas. Um mês é calculado subtraindo o valor do mês da primeira data do valor do 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 devolve 1 mês, apesar das duas datas estarem separadas por apenas um dia.

Sintaxe

integer BirtDateTime.diffMonth( Date date1, Date date2 )

Parâmetros

date1

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

date2

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

Devoluções

Integer. O número de meses entre duas datas.

Exemplos

O exemplo seguinte devolve o número de meses entre datas específicas:

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

O exemplo seguinte devolve o número de meses desde a data actual até ao início de 2010:

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

O exemplo seguinte devolve o número de meses entre valores nos campos ProjectStart (Início de projecto) e ProjectComplete (Conclusão de projecto):

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

BirtDateTime.diffQuarter

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

Sintaxe

integer BirtDateTime.diffQuarter( Date date1, Date date2 )

Parâmetros

date1

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

date2

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

Devoluções

Integer. O número de trimestres entre duas datas.

Exemplos

O exemplo seguinte devolve o número de trimestres entre datas específicas:

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

O exemplo seguinte devolve o número de trimestres desde a data actual até ao início de 2010:

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

O exemplo seguinte devolve o número de trimestres entre valores nos campos ProjectStart (Início de projecto) e ProjectComplete (Conclusão de projecto):

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

BirtDateTime.diffSecond

Esta função devolve o número de segundos entre duas datas. Se uma data não possuir um valor de hora, a função parte do princípio que a hora é meia-noite (00h00m00s).

Sintaxe

integer BirtDateTime.diffSecond( date1, date2 )

Parâmetros

date1

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

date2

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

Devoluções

Integer. O número de segundos entre duas datas.

Exemplos

O exemplo seguinte devolve o número de segundos entre datas específicas:

BirtDateTime.diffSecond( "2009-01-31 11:30:30", "2009-01-31 12:00:00")
// devolve 1770
BirtDateTime.diffSecond( "2009-01-31", "2009-01-31 1:00:00")
// devolve 3600. Dado que a primeira data não tem uma hora, é utilizada meia-noite.

O exemplo seguinte devolve o número de segundos desde a data e hora actuais até ao início de 2010:

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

O exemplo seguinte devolve o número de segundos entre valores nos campos StartTime (Hora de início) e FinishTime (Hora de conclusão):

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

BirtDateTime.diffWeek

Esta função devolve 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 devolve 1 semana, apesar das duas datas estarem separadas apenas por três dias.

Sintaxe

integer BirtDateTime.diffWeek( Date date1, Date date2 )

Parâmetros

date1

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

date2

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

Devoluções

Integer. O número de semanas entre duas datas.

Exemplos

O exemplo seguinte devolve o número de semanas entre datas específicas:

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

O exemplo seguinte devolve o número de semanas desde a data actual até ao início de 2010:

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

O exemplo seguinte devolve o número de semanas entre valores nos campos ProjectStart (Início de projecto) e ProjectComplete (Conclusão de projecto):

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

BirtDateTime.diffYear

Esta função devolve o número de anos entre duas datas. Um ano é calculado subtraindo o valor do ano da primeira data do valor do 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 devolve 0. Caso a primeira data for 2008-11-15 e a segunda data for 2009-01-15, a função também devolve 1.

Sintaxe

integer BirtDateTime.diffYear( Date date1, Date date2 )

Parâmetros

date1

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

date2

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

Devoluções

Integer. O número de anos entre duas datas.

Exemplos

O exemplo seguinte devolve o número de anos entre datas específicas:

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

O exemplo seguinte devolve o número de anos entre valores no campo HireDate (Data de contratação) e a data actual:

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

BirtDateTime.diffYear

Esta função devolve o número de anos entre duas datas. Um ano é calculado subtraindo o valor do ano da primeira data do valor do 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 devolve 0. Caso a primeira data for 2008-11-15 e a segunda data for 2009-01-15, a função também devolve 1.

Sintaxe

integer BirtDateTime.diffYear( Date date1, Date date2 )

Parâmetros

date1

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

date2

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

Devoluções

Integer. O número de anos entre duas datas.

Exemplos

O exemplo seguinte devolve o número de anos entre datas específicas:

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

O exemplo seguinte devolve o número de anos entre valores no campo HireDate (Data de contratação) e a data actual:

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

BirtDateTime.firstDayOfMonth

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

Sintaxe

Date BirtDateTime.firstDayOfMonth( Date date)

Parâmetros

date

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

Devoluções

Objecto Date. O primeiro dia do mês para uma determinada data.

Exemplos

O exemplo seguinte mostra os valores de mês devolvidos para uma data específica:

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

BirtDateTime.firstDayOfQuarter

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

Sintaxe

Date BirtDateTime.firstDayOfQuarter( Date date)

Parâmetros

date

Um objecto de data do qual obter o trimestre.

Devoluções

Objecto Date. O primeiro dia do trimestre para uma determinada data.

Exemplos

O exemplo seguinte mostra os valores de trimestre devolvidos para uma data específica:

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

BirtDateTime.firstDayOfWeek

Esta função devolve a data para o primeiro dia da semana em que a data de entrada recai, que é sempre um Domingo.

Sintaxe

Date BirtDateTime.firstDayOfWeek( Date date)

Parâmetros

date

Um objecto de data do qual obter a semana.

Devoluções

Objecto Date. O primeiro dia da semana para uma determinada data.

Exemplos

O exemplo seguinte mostra os valores de semana devolvidos para uma data específica:

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

BirtDateTime.firstDayOfYear

Esta função devolve a data para o primeiro dia do ano em que a data de entrada recai.

Sintaxe

Date BirtDateTime.firstDayOfYear( Date date)

Parâmetros

date

Um objecto de data do qual obter o ano.

Devoluções

Objecto Date. O primeiro dia do ano para uma determinada data.

Exemplos

O exemplo seguinte mostra os valores de ano devolvidos para uma data específica:

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

BirtDateTime.month

Esta função devolve o mês de uma determinada data. Dependendo da opção que especificar, a função devolve o mês como um número ou o nome completo ou abreviado do mês. O nome do mês é específico do local.

Sintaxe

string BirtDateTime.month( Date date, integer option )

Parâmetros

date

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

option

Integer. Opcional. Um número que representa o formato de mês a devolver. Utilize um dos seguintes valores:

*
*
*

Caso omita este argumento, a função devolve o mês como um número.

Devoluções

String. O mês de uma determinada data.

Exemplos

O exemplo seguinte mostra os valores de mês devolvidos para uma data específica:

BirtDateTime.month( "2009-02-15" ) // devolve 2
BirtDateTime.month( "2009-02-15", 2 ) // devolve Fevereiro
BirtDateTime.month( "2009-02-15", 3) // devolve Fev.

O exemplo seguinte devolve o mês da data actual:

BirtDateTime.month( (BirtDateTime.today() )

BirtDateTime.now

Esta função devolve a data e hora actuais como, por exemplo, 2 de Fev. de 2009, 02h05.

Sintaxe

Date BirtDateTime.now( )

Devoluções

Objecto Date. A data e hora actuais.

Exemplo

O exemplo seguinte devolve o número de horas desde a data actual até ao dia de Natal:

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

BirtDateTime.quarter

Esta função devolve um número entre 1 e 4 que representa o trimestre em que calha uma determinada data. O primeiro trimestre começa a 1 de Janeiro.

Sintaxe

integer BirtDateTime.quarter( Date date )

Parâmetro

date

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

Devoluções

Integer. O número de trimestre para uma determinada data.

Exemplos

O exemplo seguinte mostra os números de trimestre devolvidos para datas específicas:

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

O seguinte exemplo devolve o número de trimestre para cada valor no campo CloseDate (Data de fecho):

BirtDateTime.quarter( row["CloseDate"] )

O exemplo seguinte devolve o número de trimestre para a data actual:

BirtDateTime.quarter( (BirtDateTime.today() )

BirtDateTime.today

Esta função devolve a data actual que inclui um valor de tempo de meia-noite, por exemplo, 2 de Fevereiro, 2009 12:00 AM.

Sintaxe

Date BirtDateTime.today( )

Devoluções

Objecto Date. A data actual com um valor de hora de meia-noite.

Exemplos

O exemplo seguinte devolve o número de dias desde a data actual até ao Natal:

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

O exemplo seguinte calcula o número de anos desde cada valor no campo HireDate (Data de contratação), até à data actual.

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

BirtDateTime.week

Esta função devolve um número entre 1 e 52 que representa o número de semana de uma determinada data

Sintaxe

integer BirtDateTime.week( date )

Parâmetro

date

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

Devoluções

Integer. O número de semana para uma determinada data.

Exemplos

O exemplo seguinte mostra os números de semana devolvidos para datas específicas:

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

O seguinte exemplo devolve o número de semana para cada valor no campo CloseDate (Data de fecho):

BirtDateTime.week( row["CloseDate"] )

O exemplo seguinte devolve o número de semana para a data actual:

BirtDateTime.week( (BirtDateTime.today() )

BirtDateTime.weekDay

Esta função devolve o dia da semana de uma determinada data. Dependendo da opção que especificar, a função devolve o dia da semana como um número ou o nome completo ou abreviado do dia da semana. O nome do dia da semana é específico do local.

Sintaxe

string BirtDateTime.weekDay( Date date, integer option )

Parâmetros

date

Um objecto de data do qual obter o dia da semana.

option

Integer. Opcional. Um número que representa o formato a devolver. Utilize um dos seguintes valores:

*
*
*
*
*

Caso omita este argumento, a função assume a opção 1.

Devoluções

String. O dia da semana para uma determinada data.

Exemplos

O exemplo seguinte mostra os valores de dia da semana devolvidos para uma data específica:

BirtDateTime.weekDay( "2009-02-02" ) // devolve 2
BirtDateTime.weekDay( "2009-02-02", 2 ) // devolve 1
BirtDateTime.weekDay( "2009-02-02", 4 ) // devolve Segunda-feira

O exemplo seguinte devolve o dia da semana da data actual:

BirtDateTime.weekDay( (BirtDateTime.today() )

BirtDateTime.year

Esta função devolve o valor de ano com quatro dígitos para uma determinada data. Por exemplo, caso a data seja 2009-01-19, a função devolve 2009.

Sintaxe

integer BirtDateTime.year( date )

Parâmetro

date

Um objecto de data do qual obter o ano.

Devoluções

Integer. O valor de ano com quatro dígitos para uma determinada data.

Exemplos

O seguinte exemplo devolve o ano para cada valor no campo HireDate (Data de contratação):

BirtDateTime.year( row["HireDate"] )

O exemplo seguinte devolve o ano da data actual:

BirtDateTime.year( (BirtDateTime.today())

(c) Copyright Actuate Corporation 2013