Anterior Siguiente

Clase BirtDateTime

La clase BirtDateTime proporciona funciones para determinar la cantidad de tiempo existente entre dos fechas u horas, para sumar o restar períodos de tiempo, y para obtener partes de una fecha. Debido a que los periodos de tiempo son sólo números, la aplicación puede utilizar cálculos matemáticos normales con ellos: multiplicación, división, suma, resta, etc. Esta clase es estática. La aplicación no puede crear instancias de la clase.

BirtDateTime.addDay

Esta función devuelve una fecha nueva que es el resultado de añadir un número dado de días a una fecha. El número de días a añadir puede ser negativo. En este caso, el resultado es como si ese número se restara de la fecha.

Sintaxis

Date BirtDateTime.addDay( Date date, Number n )

Parámetros

date

Objeto de fecha. Objeto de fecha que representa la fecha inicial.

n

Objeto de número. Número de días a sumar a la fecha. Los decimales se tratan como enteros, redondeando a la baja al entero más cercano.

Devuelve

Objeto de fecha. Una fecha resultante de sumar el número de días especificado a la fecha inicial.

Ejemplos

El ejemplo siguiente añade días a una fecha específica:

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

El ejemplo siguiente añade 15 días a cada valor de fecha en el campo InvoiceDate:

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

BirtDateTime.addHour

Esta función devuelve una fecha nueva que es el resultado de añadir un número dado de horas a una fecha. El número de horas a añadir puede ser negativo. En este caso, el resultado es como si ese número se restara de la fecha.

Sintaxis

Date BirtDateTime.addHour( Date date, Number n )

Parámetros

date

Objeto de fecha que representa la fecha inicial. Si una fecha inicial no tiene un valor de hora, la función presupone que la hora es la medianoche (00:00:00).

n

Objeto de número. Número de horas que se deben sumar a la fecha.

Devuelve

Objeto de fecha. Una fecha resultante de sumar el número de horas especificado a la fecha inicial.

Ejemplos

El ejemplo siguiente añade horas a una fecha y hora específicas:

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

El ejemplo siguiente añade 36 horas a cada valor de fecha en el campo StartTime:

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

BirtDateTime.addMinute

Esta función devuelve una fecha nueva que es el resultado de añadir un número dado de minutos a una fecha. El número de minutos a añadir puede ser negativo. En este caso, el resultado es como si ese número se restara de la fecha.

Sintaxis

Date BirtDateTime.addMinute( Date date, Number n )

Parámetros

date

Objeto de fecha que representa la fecha inicial. Si una fecha inicial no tiene un valor de hora, la función presupone que la hora es la medianoche (00:00:00).

n

Objeto de número. Número de minutos que se deben sumar a la fecha.

Devuelve

Objeto de fecha. Una fecha resultante de sumar el número de minutos especificado a la fecha inicial.

Ejemplos

El ejemplo siguiente añade minutos a una fecha y hora específicas:

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

El ejemplo siguiente añade 15 minutos a cada valor de fecha en el campo StartTime:

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

BirtDateTime.addMonth

Esta función devuelve una fecha nueva que es el resultado de añadir un número dado de meses a una fecha. El número de meses a añadir puede ser negativo. En este caso, el resultado es como si ese número se restara de la fecha.

Esta función siempre devuelve una fecha válida. Si es necesario, la parte de día de la fecha resultante se ajusta por abajo al último día del mes resultante en el año resultante. Por ejemplo, si añade 1 mes a Jan 31, 2008, addMonth( ) devuelve Feb 29, 2008 (2008 es un año bisiesto), no Feb 31, 2008.

Sintaxis

Date BirtDateTime.addMonth( Date date, Number n )

Parámetros

date

Objeto de fecha. Objeto de fecha que representa la fecha inicial.

n

Objeto de número. Número de meses a sumar a la fecha. Los decimales se tratan como enteros, redondeando a la baja.

Devuelve

Objeto de fecha. Una fecha resultante de sumar el número de meses especificado a la fecha inicial.

Ejemplos

El ejemplo siguiente añade meses a una fecha específica:

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

El ejemplo siguiente añade 10 meses a cada valor de fecha en el campo InvoiceDate:

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

BirtDateTime.addQuarter

Esta función devuelve una fecha nueva que es el resultado de añadir un número dado de trimestres a una fecha. Un trimestre equivale a tres meses. Por ejemplo, si añade 2 trimestres a Sep 10, 2008, la función devuelve Mar 10, 2009. El número de trimestres a añadir puede ser negativo. En este caso, el resultado es como si ese número se restara de la fecha.

Sintaxis

Date BirtDateTime.addQuarter( Date date, Number n )

Parámetros

date

Objeto de fecha que representa la fecha inicial.

n

Objeto de número. Número de trimestres que se deben sumar a la fecha.

Devuelve

Objeto de fecha. Una fecha resultante de sumar el número de trimestres especificado a la fecha inicial.

Ejemplos

El ejemplo siguiente añade trimestres a una fecha específica:

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

El ejemplo siguiente añade 2 trimestres a cada valor de fecha en el campo ForecastClosing:

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

BirtDateTime.addSecond

Esta función devuelve una fecha nueva que es el resultado de añadir un número dado de segundos a una fecha. El número de segundos a añadir puede ser negativo. En este caso, el resultado es como si ese número se restara de la fecha.

Sintaxis

Date BirtDateTime.addSecond( Date date, Number n )

Parámetros

date

Objeto de fecha que representa la fecha inicial. Si una fecha inicial no tiene un valor de hora, la función presupone que la hora es la medianoche (00:00:00).

n

Objeto de número. Número de segundos que se deben sumar a la fecha.

Devuelve

Objeto de fecha. El resultado de sumar el número de segundos especificado a la fecha inicial.

Ejemplos

El ejemplo siguiente añade segundos a una fecha y hora específicas:

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

El ejemplo siguiente añade 6000 segundos a cada valor de fecha en el campo StartTime:

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

BirtDateTime.addWeek

Esta función devuelve una fecha nueva que es el resultado de añadir un número dado de semanas a una fecha. El número de semanas a añadir puede ser negativo. En este caso, el resultado es como si ese número se restara de la fecha.

Sintaxis

Date BirtDateTime.addWeek( Date date, Number n )

Parámetros

date

Objeto de fecha que representa la fecha inicial.

n

Objeto de número. Número de semanas que se deben sumar a la fecha.

Devuelve

Objeto de fecha. Una fecha resultante de sumar el número de semanas especificado a la fecha inicial.

Ejemplos

El ejemplo siguiente añade semanas a una fecha específica:

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

El ejemplo siguiente añade 2 semanas a cada valor de fecha en el campo InvoiceDate:

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

BirtDateTime.addYear

Esta función devuelve una fecha nueva que es el resultado de añadir un número dado de años a una fecha. El número de años a añadir puede ser negativo. En este caso, el resultado es como si ese número se restara de la fecha.

Sintaxis

Date BirtDateTime.addYear( Date date, Number n )

Parámetros

date

Objeto de fecha que representa la fecha inicial.

n

Objeto de número. Número de años a sumar a la fecha. Los decimales se tratan como enteros, redondeando a la baja.

Devuelve

Una fecha resultante de sumar el número de años especificado a la fecha inicial.

Ejemplos

El ejemplo siguiente añade años a una fecha específica:

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

El ejemplo siguiente añade 5 años a cada valor de fecha en el campo HireDate:

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

BirtDateTime.day

Esta función devuelve un número de 1 a 31 que representa el día del mes para una fecha dada. Por ejemplo, si la fecha es 2009-01-19, la función devuelve 19.

Sintaxis

integer BirtDateTime.day( Date date )

Parámetro

date

Objeto de fecha. Objeto de fecha del que obtener el día.

Devuelve

Un entero que representa el día del mes para una fecha dada.

Ejemplos

El ejemplo siguiente devuelve el día del mes para cada valor en el campo ShipDate:

BirtDateTime.day( row["ShipDate"] )

El ejemplo siguiente devuelve el día del mes para la fecha actual:

BirtDateTime.day( (BirtDateTime.today())

BirtDateTime.diffDay

Esta función devuelve el número de días entre dos fechas. Un día se calcula restando el valor de día de la primera fecha del valor de día de la segunda fecha. Por ejemplo, si la primera fecha es 2008-12-30 23:59:59 y la segunda fecha es 2008-12-31 00:00:00, la función devuelve 1 día, aunque solamente un segundo separa a las dos fechas.

Sintaxis

integer BirtDateTime.diffDay( Date date1, Date date2 )

Parámetros

date1

Objeto de fecha que representa el inicio del período de tiempo.

date2

Objeto de fecha que representa el final del período de tiempo.

Devuelve

Entero. El número de días entre dos fechas.

Ejemplos

El ejemplo siguiente devuelve el número de días entre fechas específicas:

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

El ejemplo siguiente devuelve el número de días desde la fecha actual al final de 2009:

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

El ejemplo siguiente devuelve el número de días entre los valores de los campos InvoiceDate y PaymentDate:

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

BirtDateTime.diffHour

Esta función devuelve el número de horas entre dos fechas. Una hora se calcula restando el valor de hora de la primera fecha del valor de hora de la segunda fecha. Por ejemplo, si la primera fecha es 2009-01-31 1:30:00 y la segunda fecha es 2009-01-31 2:00:00, la función devuelve 1 hora, aunque solamente 30 minutos separan las dos fechas. Si una fecha no tiene un valor de hora, la función presupone que la hora es la medianoche (00:00:00).

Sintaxis

integer BirtDateTime.diffHour( Date date1, Date date2 )

Parámetros

date1

Objeto de fecha que representa el inicio del período de tiempo.

date2

Objeto de fecha que representa el final del período de tiempo.

Devuelve

Entero. El número de horas entre dos fechas.

Ejemplos

El ejemplo siguiente devuelve el número de horas entre fechas específicas:

BirtDateTime.diffHour( "2009-01-31 12:00:00", "2009-02-01 12:00:00")
// devuelve 24
BirtDateTime.diffHour( "2009-01-31", "2009-02-01 12:00:00")
// devuelve 36. Debido a que la primera fecha no tiene hora, se toma medianoche.

El ejemplo siguiente devuelve el número de horas desde la fecha y hora actual hasta el fin de 2009:

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

El ejemplo siguiente devuelve el número de horas entre los valores de los campos StartTime y FinishTime:

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

BirtDateTime.diffMinute

Esta función devuelve el número de minutos entre dos fechas. Un minuto se calcula restando el valor de minuto de la primera fecha del valor de minuto de la segunda fecha. Por ejemplo, si la primera fecha es 2009-01-31 1:30:59 y la segunda fecha es 2009-01-31 1:31:00, la función devuelve 1 minuto, aunque solamente un segundo separa a las dos fechas. Si una fecha no tiene un valor de hora, la función presupone que la hora es la medianoche (00:00:00).

Sintaxis

integer BirtDateTime.diffMinute( Date date1, Date date2 )

Parámetros

date1

Objeto de fecha que representa el inicio del período de tiempo.

date2

Objeto de fecha que representa el final del período de tiempo.

Devuelve

Entero. El número de minutos entre dos fechas.

Ejemplos

El ejemplo siguiente devuelve el número de minutos entre fechas específicas:

BirtDateTime.diffMinute( "2009-01-31 1:30:30", "2009-01-31 10:45:00")
// devuelve 555
BirtDateTime.diffMinute( "2009-01-31", "2009-01-31 12:00:00")
// devuelve 720. Debido a que la primera fecha no tiene hora, se toma medianoche.

El ejemplo siguiente devuelve el número de minutos desde la fecha y hora actual hasta el principio de 2010:

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

El ejemplo siguiente devuelve el número de minutos entre los valores de los campos StartTime y FinishTime:

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

BirtDateTime.diffMonth

Esta función devuelve el número de meses entre dos fechas. Un mes se calcula restando el valor de mes de la primera fecha del valor de mes de la segunda fecha. Por ejemplo, si la primera fecha es 2009-01-31 y la segunda fecha es 2009-02-01, la función devuelve 1 mes, incluso aunque solo haya un día entre las dos fechas.

Sintaxis

integer BirtDateTime.diffMonth( Date date1, Date date2 )

Parámetros

date1

Objeto de fecha que representa el inicio del período de tiempo.

date2

Objeto de fecha que representa el final del período de tiempo.

Devuelve

Entero. El número de meses entre dos fechas.

Ejemplos

El ejemplo siguiente devuelve el número de meses entre fechas específicas:

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

El ejemplo siguiente devuelve el número de meses desde la fecha actual hasta el principio de 2010:

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

El ejemplo siguiente devuelve el número de meses entre los valores de los campos ProjectStart y ProjectComplete:

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

BirtDateTime.diffQuarter

Esta función devuelve el número de trimestres entre dos fechas. Un trimestre se calcula restando el valor de mes de la primera fecha del valor de mes de la segunda fecha. Una diferencia de 3 meses es igual a 1 trimestre. Por ejemplo, si la primera fecha es 2009-01-31 y la segunda fecha es 2009-07-01, la función devuelve 2. Si la primera fecha es 2009-01-01 y la segunda fecha es 2009-09-30, la función también devuelve 2.

Sintaxis

integer BirtDateTime.diffQuarter( Date date1, Date date2 )

Parámetros

date1

Objeto de fecha que representa el inicio del período de tiempo.

date2

Objeto de fecha que representa el final del período de tiempo.

Devuelve

Entero. El número de trimestres entre dos fechas.

Ejemplos

El ejemplo siguiente devuelve el número de trimestres entre fechas específicas:

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

El ejemplo siguiente devuelve el número de trimestres desde la fecha actual hasta el principio de 2010:

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

El ejemplo siguiente devuelve el número de trimestres entre los valores de los campos ProjectStart y ProjectComplete:

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

BirtDateTime.diffSecond

Esta función devuelve el número de segundos entre dos fechas. Si una fecha no tiene un valor de hora, la función presupone que la hora es la medianoche (00:00:00).

Sintaxis

integer BirtDateTime.diffSecond( date1, date2 )

Parámetros

date1

Objeto de fecha que representa el inicio del período de tiempo.

date2

Objeto de fecha que representa el final del período de tiempo.

Devuelve

Entero. El número de segundos entre dos fechas.

Ejemplos

El ejemplo siguiente devuelve el número de segundos entre fechas específicas:

BirtDateTime.diffSecond( "2009-01-31 11:30:30", "2009-01-31 12:00:00")
// devuelve 1770
BirtDateTime.diffSecond( "2009-01-31", "2009-01-31 1:00:00")
// devuelve 3600. Debido a que la primera fecha no tiene hora, se toma medianoche.

El ejemplo siguiente devuelve el número de segundos desde la fecha y hora actual hasta el principio de 2010:

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

El ejemplo siguiente devuelve el número de segundos entre los valores de los campos StartTime y FinishTime:

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

BirtDateTime.diffWeek

Esta función devuelve el número de semanas entre dos fechas. Una semana se calcula restando el número de semana de la primera fecha del número de semana de la segunda fecha. Por ejemplo, si la primera fecha es 2009-01-02 (semana 1 del año) y la segunda fecha es 2009-01-05 (semana 2 del año), la función devuelve 1 semana, aunque solamente haya tres días entre las dos fechas.

Sintaxis

integer BirtDateTime.diffWeek( Date date1, Date date2 )

Parámetros

date1

Objeto de fecha que representa el inicio del período de tiempo.

date2

Objeto de fecha que representa el final del período de tiempo.

Devuelve

Entero. El número de semanas entre dos fechas.

Ejemplos

El ejemplo siguiente devuelve el número de semanas entre fechas específicas:

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

El ejemplo siguiente devuelve el número de semanas desde la fecha actual hasta el principio de 2010:

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

El ejemplo siguiente devuelve el número de semanas entre los valores de los campos ProjectStart y ProjectComplete:

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

BirtDateTime.diffYear

Esta función devuelve el número de años entre dos fechas. Un año se calcula restando el valor de año de la primera fecha del valor de año de la segunda fecha. Por ejemplo si la primera fecha es 2009-01-01 y la segunda fecha es 2009-12-31, la función devuelve 0. Si la primera fecha es 2008-11-15 y la segunda fecha es 2009-01-15, la función devuelve 1.

Sintaxis

integer BirtDateTime.diffYear( Date date1, Date date2 )

Parámetros

date1

Objeto de fecha que representa el inicio del período de tiempo.

date2

Objeto de fecha que representa el final del período de tiempo.

Devuelve

Entero. El número de años entre dos fechas.

Ejemplos

El ejemplo siguiente devuelve el número de años entre fechas específicas:

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

El ejemplo siguiente devuelve el número de años entre cada valor en el campo HireDate y la fecha actual:

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

BirtDateTime.diffYear

Esta función devuelve el número de años entre dos fechas. Un año se calcula restando el valor de año de la primera fecha del valor de año de la segunda fecha. Por ejemplo si la primera fecha es 2009-01-01 y la segunda fecha es 2009-12-31, la función devuelve 0. Si la primera fecha es 2008-11-15 y la segunda fecha es 2009-01-15, la función devuelve 1.

Sintaxis

integer BirtDateTime.diffYear( Date date1, Date date2 )

Parámetros

date1

Objeto de fecha que representa el inicio del período de tiempo.

date2

Objeto de fecha que representa el final del período de tiempo.

Devuelve

Entero. El número de años entre dos fechas.

Ejemplos

El ejemplo siguiente devuelve el número de años entre fechas específicas:

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

El ejemplo siguiente devuelve el número de años entre cada valor en el campo HireDate y la fecha actual:

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

BirtDateTime.firstDayOfMonth

Esta función devuelve la fecha para el primer día del mes en el que cae la fecha de entrada.

Sintaxis

Date BirtDateTime.firstDayOfMonth( Date date)

Parámetros

date

Objeto de fecha del que obtener el mes.

Devuelve

Objeto de fecha. El primer día del mes para una fecha dada.

Ejemplos

El ejemplo siguiente muestra los valores de mes devueltos para una fecha específica:

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

BirtDateTime.firstDayOfQuarter

Esta función devuelve la fecha para el primer día del trimestre en el que cae la fecha de entrada.

Sintaxis

Date BirtDateTime.firstDayOfQuarter( Date date)

Parámetros

date

Objeto de fecha del que obtener el trimestre.

Devuelve

Objeto de fecha. El primer día del trimestre para una fecha dada.

Ejemplos

El ejemplo siguiente muestra los valores de trimestre devueltos para una fecha específica:

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

BirtDateTime.firstDayOfWeek

Esta función devuelve la fecha para el primer día de la semana en el que cae la fecha de entrada, que es siempre un domingo.

Sintaxis

Date BirtDateTime.firstDayOfWeek( Date date)

Parámetros

date

Objeto de fecha del que obtener la semana.

Devuelve

Objeto de fecha. El primer día de la semana para una fecha dada.

Ejemplos

El ejemplo siguiente muestra los valores de semana devueltos para una fecha específica:

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

BirtDateTime.firstDayOfYear

Esta función devuelve la fecha para el primer día del año en el que cae la fecha de entrada.

Sintaxis

Date BirtDateTime.firstDayOfYear( Date date)

Parámetros

date

Objeto de fecha del que obtener el año.

Devuelve

Objeto de fecha. El primer día del año para una fecha dada.

Ejemplos

El ejemplo siguiente muestra los valores de año devueltos para una fecha específica:

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

BirtDateTime.month

Esta función devuelve el mes para una fecha dada. Dependiendo de la opción que especifique, la función devolverá el mes como un número, el nombre de mes completo, o el nombre de mes abreviado. El nombre de mes es específico de cada entorno local.

Sintaxis

string BirtDateTime.month( Date date, integer option )

Parámetros

date

Objeto de fecha del que obtener el mes.

option

Entero. Opcional. Un número que representa el formato de mes a devolver. Utilice uno de los valores siguientes:

*
*
*

Si omite este argumento, la función devuelve el mes como un número.

Devuelve

Serie. El mes para una fecha dada.

Ejemplos

El ejemplo siguiente muestra los valores de mes devueltos para una fecha específica:

BirtDateTime.month( "2009-02-15" ) // devuelve 2
BirtDateTime.month( "2009-02-15", 2 ) // devuelve Febrero
BirtDateTime.month( "2009-02-15", 3) // devuelve Feb

El ejemplo siguiente devuelve el mes para la fecha actual:

BirtDateTime.month( (BirtDateTime.today() )

BirtDateTime.now

Esta función devuelve la fecha y hora actual, por ejemplo, Feb 2, 2009 2:05 PM.

Sintaxis

Date BirtDateTime.now( )

Devuelve

Objeto de fecha. La fecha y hora actuales.

Ejemplo

El ejemplo siguiente devuelve el número de horas desde la fecha y hora actual hasta Navidad:

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

BirtDateTime.quarter

Esta función devuelve un número de 1 a 4 que representa el trimestre en que cae una fecha dada. El primer trimestre empieza el 1 de enero.

Sintaxis

integer BirtDateTime.quarter( Date date )

Parámetro

date

Objeto de fecha del que obtener el número de trimestre.

Devuelve

Entero. El número de trimestre para una fecha dada.

Ejemplos

El ejemplo siguiente muestra los números de trimestre devueltos para fechas específicas:

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

El ejemplo siguiente devuelve el número de trimestre para cada valor en el campo CloseDate:

BirtDateTime.quarter( row["CloseDate"] )

El ejemplo siguiente devuelve el número de trimestre para la fecha actual:

BirtDateTime.quarter( (BirtDateTime.today() )

BirtDateTime.today

Esta función devuelve la fecha actual que incluye un valor de medianoche, por ejemplo, 2 Feb, 2009 12:00 AM.

Sintaxis

Date BirtDateTime.today( )

Devuelve

Objeto de fecha. La fecha actual con un valor de hora de medianoche.

Ejemplos

El ejemplo siguiente devuelve el número de días desde la fecha actual hasta Navidad:

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

El ejemplo siguiente calcula número de años desde cada valor en el campo de datos HireDate a la fecha actual.

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

BirtDateTime.week

Esta función devuelve un número de 1 a 52 que representa el número de semana para una fecha dada.

Sintaxis

integer BirtDateTime.week( date )

Parámetro

date

Objeto de fecha del que obtener el número de semana.

Devuelve

Entero. El número de semana para una fecha dada.

Ejemplos

El ejemplo siguiente muestra los números de semana devueltos para fechas específicas:

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

El ejemplo siguiente devuelve el número de semana para cada valor en el campo CloseDate:

BirtDateTime.week( row["CloseDate"] )

El ejemplo siguiente devuelve el número de semana para la fecha actual:

BirtDateTime.week( (BirtDateTime.today() )

BirtDateTime.weekDay

Esta función devuelve el día de la semana para una fecha dada. Dependiendo de la opción que especifique, la función devolverá el día de la semana como un número, el nombre de día de la semana completo, o el nombre de día de la semana abreviado. El nombre de día de la semana es específico de cada entorno local.

Sintaxis

string BirtDateTime.weekDay( Date date, integer option )

Parámetros

date

Objeto de fecha del que obtener el día de la semana.

option

Entero. Opcional. Un número que representa el formato a devolver. Utilice uno de los valores siguientes:

*
*
*
*
*

Si omite este argumento, la función toma la opción 1.

Devuelve

Serie. El día de la semana para una fecha dada.

Ejemplos

El ejemplo siguiente muestra los valores de día de la semana devueltos para una fecha específica:

BirtDateTime.weekDay( "2009-02-02" ) // devuelve 2
BirtDateTime.weekDay( "2009-02-02", 2 ) // devuelve 1
BirtDateTime.weekDay( "2009-02-02", 4 ) // devuelve Lunes

El ejemplo siguiente devuelve el día de la semana para la fecha actual:

BirtDateTime.weekDay( (BirtDateTime.today() )

BirtDateTime.year

Esta función devuelve el valor de año de cuatro dígitos para una fecha dada. Por ejemplo, si la fecha es 2009-01-19, la función devuelve 2009.

Sintaxis

integer BirtDateTime.year( date )

Parámetro

date

Objeto de fecha del que obtener el año.

Devuelve

Entero. El valor de año de cuatro dígitos para una fecha dada.

Ejemplos

El ejemplo siguiente devuelve el año para cada valor en el campo HireDate:

BirtDateTime.year( row["HireDate"] )

El ejemplo siguiente devuelve el año para la fecha actual:

BirtDateTime.year( (BirtDateTime.today())

(c) Copyright Actuate Corporation 2013