Vorheriges Nächstes

Klasse "BirtDateTime"

Die Klasse 'BirtDateTime' stellt Funktionen bereit, mit denen der Zeitraum zwischen zwei Datums- oder Zeitwerten ermittelt werden kann, Zeitspannen addiert bzw. subtrahiert werden können und Teile eines Datums abgerufen werden können. Da es sich bei Datumszeiträumen lediglich um Zahlen handelt, kann die Anwendung normale mathematische Operationen auf diese Zahlen anwenden, nämlich Multiplikation, Division, Addition, Subtraktion usw. Diese Klasse ist statisch. Die Anwendung kann keine Instanzen der Klasse erstellen.

BirtDateTime.addDay

Diese Funktion gibt ein neues Datum zurück, das aus der Addition der angegebenen Anzahl von Tagen zu einem Datum hervorgeht. Als Anzahl der Tage, die addiert werden soll, kann auch eine negative Zahl verwendet werden. In diesem Fall entspricht das Ergebnis der Subtraktion dieser Zahl vom Datum.

Syntax

Date BirtDateTime.addDay( Date datum, Number n )

Parameter

datum

Datumsobjekt (Date). Ein Datumsobjekt (Date), das das Startdatum darstellt.

n

Zahlenobjekt (Number). Die Anzahl der Tage, die zum Datum addiert werden soll. Dezimalzahlen werden als Ganzzahlen (Integer) behandelt und auf die nächste Ganzzahl abgerundet.

Rückgabe

Datumsobjekt (Date). Ein Datum, das aus der Addition der angegebenen Anzahl von Tagen zum Startdatum hervorgeht.

Beispiele

Im folgenden Beispiel werden Tage zu einem bestimmten Datum addiert:

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

Im folgenden Beispiel werden 15 Tage zu jedem Datumswert im Feld "InvoiceDate" addiert:

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

BirtDateTime.addHour

Diese Funktion gibt ein neues Datum zurück, das aus der Addition der angegebenen Anzahl von Stunden zu einem Datum hervorgeht. Als Anzahl der Stunden, die addiert werden soll, kann auch eine negative Zahl verwendet werden. In diesem Fall entspricht das Ergebnis der Subtraktion dieser Zahl vom Datum.

Syntax

Date BirtDateTime.addHour( Date datum, Number n )

Parameter

datum

Ein Datumsobjekt (Date), das das Startdatum darstellt. Wenn ein Startdatum keinen Zeitwert besitzt, setzt die Funktion standardmäßig Mitternacht (00:00:00) voraus.

n

Zahlenobjekt (Number). Die Anzahl der Stunden, die zum Datum addiert werden soll.

Rückgabe

Datumsobjekt (Date). Ein Datum, das aus der Addition der angegebenen Anzahl von Stunden zum Startdatum hervorgeht.

Beispiele

Im folgenden Beispiel werden Stunden zu einem bestimmten Datum und einer bestimmten Uhrzeit addiert:

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

Im folgenden Beispiel werden 36 Stunden zu jedem Datumswert im Feld "StartTime" addiert:

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

BirtDateTime.addMinute

Diese Funktion gibt ein neues Datum zurück, das aus der Addition der angegebenen Anzahl von Minuten zu einem Datum hervorgeht. Als Anzahl der Minuten, die addiert werden soll, kann auch eine negative Zahl verwendet werden. In diesem Fall entspricht das Ergebnis der Subtraktion dieser Zahl vom Datum.

Syntax

Date BirtDateTime.addMinute( Date datum, Number n )

Parameter

datum

Ein Datumsobjekt (Date), das das Startdatum darstellt. Wenn ein Startdatum keinen Zeitwert besitzt, setzt die Funktion standardmäßig Mitternacht (00:00:00) voraus.

n

Zahlenobjekt (Number). Die Anzahl der Minuten, die zum Datum addiert werden soll.

Rückgabe

Datumsobjekt (Date). Ein Datum, das aus der Addition der angegebenen Anzahl von Minuten zum Startdatum hervorgeht.

Beispiele

Im folgenden Beispiel werden Minuten zu einem bestimmten Datum und einer bestimmten Uhrzeit addiert:

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

Im folgenden Beispiel werden 15 Minuten zu jedem Datumswert im Feld "StartTime" addiert:

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

BirtDateTime.addMonth

Diese Funktion gibt ein neues Datum zurück, das aus der Addition der angegebenen Anzahl von Monaten zu einem Datum hervorgeht. Als Anzahl der Monate, die addiert werden soll, kann auch eine negative Zahl verwendet werden. In diesem Fall entspricht das Ergebnis der Subtraktion dieser Zahl vom Datum.

Diese Funktion gibt stets ein gültiges Datum zurück. Falls erforderlich, wird der Tagesteil des resultierenden Datums nach unten auf den letzten Tag des resultierenden Monats im resultierenden Jahr angepasst. Wenn Sie zum Beispiel einen Monat zum Datum '31. Januar 2008' hinzufügen, so gibt 'addMonth( )' die Angabe 'Feb 29, 2008' zurück (2008 ist ein Schaltjahr) und nicht 'Feb 31, 2008'.

Syntax

Date BirtDateTime.addMonth( Date datum, Number n )

Parameter

datum

Datumsobjekt (Date). Ein Datumsobjekt, das das Startdatum darstellt.

n

Zahlenobjekt (Number). Die Anzahl der Monate, die zum Datum addiert werden soll. Dezimalzahlen werden als Ganzzahlen (Integer) behandelt und abgerundet.

Rückgabe

Datumsobjekt (Date). Ein Datum, das aus der Addition der angegebenen Anzahl von Monaten zum Startdatum hervorgeht.

Beispiele

Im folgenden Beispiel werden Monate zu einem bestimmten Datum addiert:

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

Im folgenden Beispiel werden 10 Monate zu jedem Datumswert im Feld 'InvoiceDate' addiert:

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

BirtDateTime.addQuarter

Diese Funktion gibt ein neues Datum zurück, das aus der Addition der angegebenen Anzahl von Quartalen zu einem Datum hervorgeht. Ein Quartal entspricht einem Zeitraum von drei Monaten. Wenn Sie dem Datum '10. September 2008' zwei Quartale hinzufügen, gibt die Funktion den 10. März 2009 als Ergebnis zurück. Als Anzahl der Quartale, die addiert werden soll, kann auch eine negative Zahl verwendet werden. In diesem Fall entspricht das Ergebnis der Subtraktion dieser Zahl vom Datum.

Syntax

Date BirtDateTime.addQuarter( Date datum, Number n )

Parameter

datum

Ein Datumsobjekt (Date), das das Startdatum darstellt.

n

Zahlenobjekt (Number). Die Anzahl der Quartale, die zum Datum addiert werden soll.

Rückgabe

Datumsobjekt (Date). Ein Datum, das aus der Addition der angegebenen Anzahl von Quartalen zum Startdatum hervorgeht.

Beispiele

Im folgenden Beispiel werden Quartale zu einem bestimmten Datum addiert:

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

Im folgenden Beispiel werden 2 Quartale zu jedem Datumswert im Feld 'ForecastClosing' addiert:

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

BirtDateTime.addSecond

Diese Funktion gibt ein neues Datum zurück, das aus der Addition der angegebenen Anzahl von Sekunden zu einem Datum hervorgeht. Als Anzahl der Sekunden, die addiert werden soll, kann auch eine negative Zahl verwendet werden. In diesem Fall entspricht das Ergebnis der Subtraktion dieser Zahl vom Datum.

Syntax

Date BirtDateTime.addSecond( Date datum, Number n )

Parameter

datum

Ein Datumsobjekt (Date), das das Startdatum darstellt. Wenn ein Startdatum keinen Zeitwert besitzt, setzt die Funktion standardmäßig Mitternacht (00:00:00) voraus.

n

Zahlenobjekt (Number). Die Anzahl der Sekunden, die zum Datum addiert werden soll.

Rückgabe

Datumsobjekt (Date). Das Ergebnis der Addition der angegebenen Anzahl von Sekunden zum Startdatum.

Beispiele

Im folgenden Beispiel werden Sekunden zu einem bestimmten Datum und einer bestimmten Uhrzeit addiert:

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

Im folgenden Beispiel werden 6000 Sekunden zu jedem Datumswert im Feld 'StartTime' hinzugefügt:

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

BirtDateTime.addWeek

Diese Funktion gibt ein neues Datum zurück, das aus der Addition der angegebenen Anzahl von Wochen zu einem Datum hervorgeht. Als Anzahl der Wochen, die addiert werden soll, kann auch eine negative Zahl verwendet werden. In diesem Fall entspricht das Ergebnis der Subtraktion dieser Zahl vom Datum.

Syntax

Date BirtDateTime.addWeek( Date datum, Number n )

Parameter

datum

Ein Datumsobjekt (Date), das das Startdatum darstellt.

n

Zahlenobjekt (Number). Die Anzahl der Wochen, die zum Datum addiert werden soll.

Rückgabe

Datumsobjekt (Date). Ein Datum, das aus der Addition der angegebenen Anzahl von Wochen zum Startdatum hervorgeht.

Beispiele

Im folgenden Beispiel werden Wochen zu einem bestimmten Datum addiert:

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

Im folgenden Beispiel werden 2 Wochen zu jedem Datumswert im Feld "InvoiceDate" addiert:

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

BirtDateTime.addYear

Diese Funktion gibt ein neues Datum zurück, das aus der Addition der angegebenen Anzahl von Jahren zu einem Datum hervorgeht. Als Anzahl der Jahre, die addiert werden soll, kann auch eine negative Zahl verwendet werden. In diesem Fall entspricht das Ergebnis der Subtraktion dieser Zahl vom Datum.

Syntax

Date BirtDateTime.addYear( Date datum, Number n )

Parameter

datum

Ein Datumsobjekt (Date), das das Startdatum darstellt.

n

Zahlenobjekt (Number). Die Anzahl der Jahre, die zum Datum addiert werden soll. Dezimalzahlen werden als Ganzzahlen (Integer) behandelt und abgerundet.

Rückgabe

Ein Datum, das aus der Addition der angegebenen Anzahl von Jahren zum Startdatum hervorgeht.

Beispiele

Im folgenden Beispiel werden Jahre zu einem bestimmten Datum addiert:

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

Im folgenden Beispiel werden 5 Jahre zu jedem Datumswert im Feld "HireDate" addiert:

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

BirtDateTime.day

Diese Funktion gibt eine Zahl zwischen 1 und 31 zurück, die den Tag des Monats für ein angegebenes Datum darstellt. Wenn das Datum zum Beispiel den 19. Januar 2009 ('2009-01-19') vorgibt, so gibt die Funktion den Wert 19 zurück.

Syntax

integer BirtDateTime.day( Date datum )

Parameter

datum

Datumsobjekt (Date). Ein Datumsobjekt, aus dem der Tag abgerufen wird.

Rückgabe

Integer. Eine ganze Zahl, die den Tag des Monates für ein angegebenes Datum darstellt.

Beispiele

Das folgende Beispiel gibt den Tag des Monats für jeden Wert im Feld 'ShipDate' zurück:

BirtDateTime.day( row["ShipDate"] )

Das folgende Beispiel gibt den Tag des Monats für das aktuelle Datum zurück:

BirtDateTime.day( (BirtDateTime.today())

BirtDateTime.diffDay

Diese Funktion gibt die Anzahl der Tage zwischen zwei Datumsangaben zurück. Ein Tag wird durch Subtraktion des Tageswerts für den ersten Datumswert vom Tageswert für den zweiten Datumswert berechnet. Wenn die erste Datums-/Zeitangabe beispielsweise '2008-12-30 23:59:59' lautet und die zweite '2008-12-31 00:00:00', so gibt die Funktion einen Tag als Ergebnis zurück, auch wenn zwischen beiden Angaben lediglich eine Sekunde liegt.

Syntax

integer BirtDateTime.diffDay( Date datum1, Date datum2 )

Parameter

datum1

Ein Datumsobjekt (Date), das den Beginn der Zeitspanne darstellt.

datum2

Ein Datumsobjekt (Date), das das Ende der Zeitspanne darstellt.

Rückgabe

Integer. Die Anzahl der Tage zwischen zwei Datumsangaben.

Beispiele

Das folgende Beispiel gibt die Anzahl der Tage zwischen zwei bestimmten Datumsangaben zurück:

BirtDateTime.diffDay( "2009-01-01", "2009-04-15" ) // Rückgabewert: 104

Das folgende Beispiel gibt die Anzahl der Tage zwischen dem aktuellen Datum und dem letzten Tag des Jahres 2009 zurück:

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

Das folgende Beispiel gibt die Anzahl der Tage zwischen den Werten in den Feldern 'InvoiceDate' und 'PaymentDate' zurück:

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

BirtDateTime.diffHour

Diese Funktion gibt die Anzahl der Stunden zwischen zwei Datumsangaben zurück. Eine Stunde wird durch Subtraktion des Stundenwerts für den ersten Datumswert vom Stundenwert für den zweiten Datumswert berechnet. Wenn die erste Datums-/Zeitangabe zum Beispiel "2009-01-31 1:30:00" lautet und die zweite "2009-01-31 2:00:00", so gibt die Funktion eine Stunde als Ergebnis zurück, auch wenn zwischen den beiden Angaben lediglich dreißig Minuten liegen. Wenn ein Datum keinen Zeitwert besitzt, setzt die Funktion standardmäßig Mitternacht (00:00:00) voraus.

Syntax

integer BirtDateTime.diffHour( Date datum1, Date datum2 )

Parameter

datum1

Ein Datumsobjekt (Date), das den Beginn der Zeitspanne darstellt.

datum2

Ein Datumsobjekt (Date), das das Ende der Zeitspanne darstellt.

Rückgabe

Integer. Die Anzahl der Stunden zwischen zwei Datumsangaben.

Beispiele

Das folgende Beispiel gibt die Anzahl der Stunden zwischen bestimmten Datumsangaben zurück:

BirtDateTime.diffHour( "2009-01-31 12:00:00", "2009-02-01 12:00:00")
// Rückgabewert: 24
BirtDateTime.diffHour( "2009-01-31", "2009-02-01 12:00:00")
// Rückgabewert: 36. Da für das erste Datum kein Zeitwert vorhanden ist, wird Mitternacht vorausgesetzt.

Das folgende Beispiel gibt die Anzahl der Stunden zwischen dem aktuellen Datum und der aktuellen Uhrzeit bis zum letzten Tag des Jahres 2009 zurück:

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

Das folgende Beispiel gibt die Anzahl der Stunden zwischen den Werten in den Feldern 'StartTime' und 'FinishTime' zurück:

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

BirtDateTime.diffMinute

Diese Funktion gibt die Anzahl der Minuten zwischen zwei Datumsangaben zurück. Eine Minute wird durch Subtraktion des Minutenwerts für den ersten Datumswert vom Minutenwert für den zweiten Datumswerts berechnet. Wenn die erste Datums-/Zeitangabe zum Beispiel "2009-01-31 1:30:59" lautet und die zweite "2009-01-31 1:31:00", so gibt die Funktion eine Minute als Ergebnis zurück, auch wenn zwischen den beiden Daten lediglich eine Sekunde liegt. Wenn ein Datum keinen Zeitwert besitzt, setzt die Funktion standardmäßig Mitternacht (00:00:00) voraus.

Syntax

integer BirtDateTime.diffMinute( Date datum1, Date datum2 )

Parameter

datum1

Ein Datumsobjekt (Date), das den Beginn der Zeitspanne darstellt.

datum2

Ein Datumsobjekt (Date), das das Ende der Zeitspanne darstellt.

Rückgabe

Integer. Die Anzahl der Minuten zwischen zwei Datumsangaben.

Beispiele

Das folgende Beispiel gibt die Anzahl der Minuten zwischen zwei bestimmten Datumsangaben zurück:

BirtDateTime.diffMinute( "2009-01-31 1:30:30", "2009-01-31 10:45:00")
// Rückgabewert: 555
BirtDateTime.diffMinute( "2009-01-31", "2009-01-31 12:00:00")
// Rückgabewert: 720. Da für das erste Datum kein Zeitwert vorhanden ist, wird Mitternacht vorausgesetzt.

Das folgende Beispiel gibt die Anzahl der Minuten zwischen dem aktuellen Datum und der aktuellen Uhrzeit bis zum ersten Tag des Jahres 2010 zurück:

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

Das folgende Beispiel gibt die Anzahl der Minuten zwischen den Werten in den Feldern 'StartTime' und 'FinishTime' zurück:

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

BirtDateTime.diffMonth

Diese Funktion gibt die Anzahl der Monate zwischen zwei Datumsangaben zurück. Eine Monat wird durch Subtraktion des Monatswerts für den ersten Datumswert vom Monatswert für den zweiten Datumswert berechnet. Wenn die erste Datumsangabe beispielsweise '2009-01-31' lautet und die zweite '2009-02-01', so gibt die Funktion einen (1) Monat als Ergebnis zurück, auch wenn zwischen den beiden Datumsangaben lediglich ein Tag liegt.

Syntax

integer BirtDateTime.diffMonth( Date datum1, Date datum2 )

Parameter

datum1

Ein Datumsobjekt (Date), das den Beginn der Zeitspanne darstellt.

datum2

Ein Datumsobjekt (Date), das das Ende der Zeitspanne darstellt.

Rückgabe

Integer. Die Anzahl der Monate zwischen zwei Datumsangaben.

Beispiele

Das folgende Beispiel gibt die Anzahl der Monate zwischen bestimmten Datumsangaben zurück:

BirtDateTime.diffMonth( "2009-01-31", "2009-04-15") // Rückgabewert: 3

Das folgende Beispiel gibt die Anzahl der Monate zwischen dem aktuellen Datum und dem ersten Tag des Jahres 2010 zurück:

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

Das folgende Beispiel gibt die Anzahl der Monate zwischen den Werten in den Feldern 'ProjectStart' und 'ProjectComplete' zurück:

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

BirtDateTime.diffQuarter

Diese Funktion gibt die Anzahl der Quartale zwischen zwei Datumsangaben zurück. Ein Quartal wird durch Subtraktion des Monatswerts für den ersten Datumswert vom Monatswert für den zweiten Datumswert berechnet. Eine Differenz von drei Monaten entspricht einem Quartal. Wenn die erste Datumsangabe beispielsweise '2009-01-31' lautet und die zweite '2009-07-01', so gibt die Funktion den Wert 2 zurück. Lautet die erste Datumsangabe '2009-01-01' und die zweite '2009-09-30', so gibt die Funktion ebenfalls den Wert 2 zurück.

Syntax

integer BirtDateTime.diffQuarter( Date datum1, Date datum2 )

Parameter

datum1

Ein Datumsobjekt (Date), das den Beginn der Zeitspanne darstellt.

datum2

Ein Datumsobjekt (Date), das das Ende der Zeitspanne darstellt.

Rückgabe

Integer. Die Anzahl der Quartale zwischen zwei Datumsangaben.

Beispiele

Das folgende Beispiel gibt die Anzahl der Quartale zwischen zwei bestimmten Datumsangaben zurück:

BirtDateTime.diffQuarter( "2009-01-31", "2009-04-15") // Rückgabewert: 1

Das folgende Beispiel gibt die Anzahl der Quartale zwischen dem aktuellen Datum und dem ersten Tag des Jahres 2010 zurück:

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

Das folgende Beispiel gibt die Anzahl der Quartale zwischen den Werten in den Feldern 'ProjectStart' und 'ProjectComplete' zurück:

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

BirtDateTime.diffSecond

Diese Funktion gibt die Anzahl der Sekunden zwischen zwei Datumsangaben zurück. Wenn ein Datum keinen Zeitwert besitzt, setzt die Funktion standardmäßig Mitternacht (00:00:00) voraus.

Syntax

integer BirtDateTime.diffSecond( datum1, datum2 )

Parameter

datum1

Ein Datumsobjekt (Date), das den Beginn der Zeitspanne darstellt.

datum2

Ein Datumsobjekt (Date), das das Ende der Zeitspanne darstellt.

Rückgabe

Integer. Die Anzahl der Sekunden zwischen zwei Datumsangaben.

Beispiele

Das folgende Beispiel gibt die Anzahl der Sekunden zwischen zwei bestimmten Datumsangaben zurück:

BirtDateTime.diffSecond( "2009-01-31 11:30:30", "2009-01-31 12:00:00")
// Rückgabewert: 1770
BirtDateTime.diffSecond( "2009-01-31", "2009-01-31 1:00:00")
// Rückgabewert: 3600. Da für das erste Datum kein Zeitwert vorhanden ist, wird Mitternacht vorausgesetzt.

Das folgende Beispiel gibt die Anzahl der Sekunden zwischen dem aktuellen Datum und der aktuellen Uhrzeit bis zum ersten Tag des Jahres 2010 zurück:

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

Das folgende Beispiel gibt die Anzahl der Sekunden zwischen den Werten in den Feldern 'StartTime' und 'FinishTime' zurück:

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

BirtDateTime.diffWeek

Diese Funktion gibt die Anzahl der Wochen zwischen zwei Datumsangaben zurück. Eine Woche wird durch Subtraktion des Wochenwerts für den ersten Datumswert vom Wochenwert für den zweiten Datumswert berechnet. Wenn die erste Datumsangabe beispielsweise '2009-01-02' lautet (Kalenderwoche 1 des Jahres) und die zweite '2009-01-05' (Kalenderwoche 2 des Jahres), so gibt die Funktion eine (1) Woche als Ergebnis zurück, auch wenn zwischen den beiden Datumsangaben lediglich drei Tage liegen.

Syntax

integer BirtDateTime.diffWeek( Date datum1, Date datum2 )

Parameter

datum1

Ein Datumsobjekt (Date), das den Beginn der Zeitspanne darstellt.

datum2

Ein Datumsobjekt (Date), das das Ende der Zeitspanne darstellt.

Rückgabe

Integer. Die Anzahl der Wochen zwischen zwei Datumsangaben.

Beispiele

Das folgende Beispiel gibt die Anzahl der Wochen zwischen zwei bestimmten Datumsangaben zurück:

BirtDateTime.diffWeek( "2009-01-01", "2009-02-01") // Rückgabewert: 5

Das folgende Beispiel gibt die Anzahl der Wochen zwischen dem aktuellen Datum und dem ersten Tag des Jahres 2010 zurück:

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

Das folgende Beispiel gibt die Anzahl der Wochen zwischen den Werten in den Feldern 'ProjectStart' und 'ProjectComplete' zurück:

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

BirtDateTime.diffYear

Diese Funktion gibt die Anzahl der Jahre zwischen zwei Datumsangaben zurück. Ein Jahr wird durch Subtraktion des Jahreswerts für den ersten Datumswert vom Jahreswert für den zweiten Datumswert berechnet. Wenn die erste Datumsangabe beispielsweise '2009-01-01' lautet und die zweite '2009-12-31', so gibt die Funktion den Wert 0 zurück. Wenn die erste Datumsangabe '2008-11-15' lautet und die zweite '2009-01-15', so gibt die Funktion den Wert 1 zurück.

Syntax

integer BirtDateTime.diffYear( Date datum1, Date datum2 )

Parameter

datum1

Ein Datumsobjekt (Date), das den Beginn der Zeitspanne darstellt.

datum2

Ein Datumsobjekt (Date), das das Ende der Zeitspanne darstellt.

Rückgabe

Integer. Die Anzahl der Jahre zwischen zwei Datumsangaben.

Beispiele

Das folgende Beispiel gibt die Anzahl der Jahre zwischen zwei bestimmten Datumsangaben zurück:

BirtDateTime.diffYear( "2005-01-01", "2009-06-01") // Rückgabewert: 4

Das folgende Beispiel gibt die Anzahl der Jahre zwischen jedem Wert im Feld 'HireDate' und dem aktuellen Datum zurück:

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

BirtDateTime.diffYear

Diese Funktion gibt die Anzahl der Jahre zwischen zwei Datumsangaben zurück. Ein Jahr wird durch Subtraktion des Jahreswerts für den ersten Datumswert vom Jahreswert für den zweiten Datumswert berechnet. Wenn die erste Datumsangabe beispielsweise '2009-01-01' lautet und die zweite '2009-12-31', so gibt die Funktion den Wert 0 zurück. Wenn die erste Datumsangabe '2008-11-15' lautet und die zweite '2009-01-15', so gibt die Funktion den Wert 1 zurück.

Syntax

integer BirtDateTime.diffYear( Date datum1, Date datum2 )

Parameter

datum1

Ein Datumsobjekt (Date), das den Beginn der Zeitspanne darstellt.

datum2

Ein Datumsobjekt (Date), das das Ende der Zeitspanne darstellt.

Rückgabe

Integer. Die Anzahl der Jahre zwischen zwei Datumsangaben.

Beispiele

Das folgende Beispiel gibt die Anzahl der Jahre zwischen zwei bestimmten Datumsangaben zurück:

BirtDateTime.diffYear( "2005-01-01", "2009-06-01") // Rückgabewert: 4

Das folgende Beispiel gibt die Anzahl der Jahre zwischen jedem Wert im Feld 'HireDate' und dem aktuellen Datum zurück:

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

BirtDateTime.firstDayOfMonth

Diese Funktion gibt das Datum für den ersten Tag des Monats zurück, in den das Eingabedatum fällt.

Syntax

Date BirtDateTime.firstDayOfMonth( Date datum)

Parameter

datum

Ein Datumsobjekt (Date), von dem der Monat abgerufen wird.

Rückgabe

Datumsobjekt (Date). Der erste Tag des Monats für ein angegebenes Datum.

Beispiele

Das folgende Beispiel zeigt, welche Monatswerte für ein bestimmtes Datum zurückgegeben werden:

BirtDateTime.firstDayOfMonth( "2009-02-15" ) // Rückgabewert: 2009-02-01

BirtDateTime.firstDayOfQuarter

Diese Funktion gibt das Datum für den ersten Tag des Quartals zurück, in das das Eingabedatum fällt.

Syntax

Date BirtDateTime.firstDayOfQuarter( Date datum)

Parameter

datum

Ein Datumsobjekt (Date), aus dem der Wert für das Quartal abgerufen wird.

Rückgabe

Datumsobjekt (Date). Der erste Tag des Quartals für ein angegebenes Datum.

Beispiele

Das folgende Beispiel zeigt, welche Quartalswerte für ein bestimmtes Datum zurückgegeben werden:

BirtDateTime.firstDayOfQuarter( "2009-02-15" ) // Rückgabewert: 2009-01-01

BirtDateTime.firstDayOfWeek

Diese Funktion gibt das Datum für den ersten Tag der Woche zurück, in die das Eingabedatum fällt. Dies ist immer ein Sonntag.

Syntax

Date BirtDateTime.firstDayOfWeek( Date datum)

Parameter

datum

Ein Datumsobjekt (Date), aus dem die Woche abgerufen wird.

Rückgabe

Datumsobjekt (Date). Der erste Tag der Woche für ein angegebenes Datum.

Beispiele

Das folgende Beispiel zeigt, welche Wochenwerte für ein bestimmtes Datum zurückgegeben werden:

BirtDateTime.firstDayOfWeek( "2009-02-15" ) // Rückgabewert: 2009-02-15

BirtDateTime.firstDayOfYear

Diese Funktion gibt das Datum für den ersten Tag des Jahres zurück, in das das Eingabedatum fällt.

Syntax

Date BirtDateTime.firstDayOfYear( Date datum)

Parameter

datum

Ein Datumsobjekt (Date), aus dem das Jahr abgerufen wird.

Rückgabe

Datumsobjekt (Date). Der erste Tag des Jahres für ein angegebenes Datum.

Beispiele

Das folgende Beispiel zeigt, welche Jahreswerte für ein bestimmtes Datum zurückgegeben werden:

BirtDateTime.firstDayOfYear( "2009-02-15" ) // Rückgabewert: 2009-01-01

BirtDateTime.month

Diese Funktion gibt den Monat für ein angegebenes Datum zurück. In Abhängigkeit von der Option, die Sie angeben, gibt die Funktion den Monat in Form einer Zahl, als vollständigen Monatsnamen oder als Monatsabkürzung zurück. Der Monatsname ist abhängig von der jeweiligen Ländereinstellung.

Syntax

string BirtDateTime.month( Date datum, integer option )

Parameter

datum

Ein Datumsobjekt (Date), von dem der Monat abgerufen wird.

option

Integer. Optional. Sie gibt eine Nummer an, die das Format darstellt, in dem der Monat zurückgegeben werden soll. Verwenden Sie einen der folgenden Werte:

*
*
*

Wenn Sie dieses Argument nicht verwenden, so gibt die Funktion den Monat als Zahl zurück.

Rückgabe

String. Der Monat für ein angegebenes Datum.

Beispiele

Das folgende Beispiel zeigt, welche Monatswerte für ein bestimmtes Datum zurückgegeben werden:

BirtDateTime.month( "2009-02-15" ) // Rückgabewert: 2
BirtDateTime.month( "2009-02-15", 2 ) // Rückgabewert: February (bzw. Februar)
BirtDateTime.month( "2009-02-15", 3) // Rückgabewert: Feb (bzw. Feb.)

Das folgende Beispiel gibt den Monat für das aktuelle Datum zurück:

BirtDateTime.month( (BirtDateTime.today() )

BirtDateTime.now

Diese Funktion gibt das aktuelle Datum und die aktuelle Zeit zurück, zum Beispiel "Feb 2, 2009 2:05 PM.

Syntax

Date BirtDateTime.now( )

Rückgabe

Datumsobjekt (Date). Das aktuelle Datum und die aktuelle Zeit.

Beispiel

Das folgende Beispiel gibt die Anzahl der Stunden zwischen dem aktuellen Datum und der aktuellen Uhrzeit und dem ersten Weihnachtsfeiertag (25. Dezember) zurück:

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

BirtDateTime.quarter

Diese Funktion gibt eine Zahl zwischen 1 und 4 zurück, die das Quartal darstellt, in das ein angegebenes Datum fällt. Das erste Quartal beginnt am 1. Januar.

Syntax

integer BirtDateTime.quarter( Date datum )

Parameter

datum

Ein Datumsobjekt (Date), von dem der Wert für das Quartal abgerufen wird.

Rückgabe

Integer. Der Quartalswert für ein angegebenes Datum.

Beispiele

Das folgende Beispiel zeigt, welche Quartalswerte für bestimmte Daten zurückgegeben werden:

BirtDateTime.quarter( "2009-02-15" ) // Rückgabewert: 1
BirtDateTime.quarter( "2009-07-10" ) // Rückgabewert: 3

Das folgende Beispiel gibt den Quartalswert für jeden Wert im Feld 'CloseDate' zurück:

BirtDateTime.quarter( row["CloseDate"] )

Das folgende Beispiel gibt den Quartalswert für das aktuelle Datum zurück:

BirtDateTime.quarter( (BirtDateTime.today() )

BirtDateTime.today

Diese Funktion gibt das aktuelle Datum zurück, das einen Zeitwert für Mitternacht enthält (beispielsweise 'Feb 2, 2009 12:00 AM').

Syntax

Date BirtDateTime.today( )

Rückgabe

Datumsobjekt (Date). Das aktuelle Datum mit Mitternacht als Zeitwert.

Beispiele

Das folgende Beispiel gibt die Anzahl der Tage zwischen dem aktuellen Datum und dem ersten Weihnachtsfeiertag (25. Dezember) zurück:

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

Das folgende Beispiel berechnet die Anzahl der Jahre zwischen jedem Wert im Datenfeld 'HireDate' und dem aktuellen Datum.

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

BirtDateTime.week

Diese Funktion gibt eine Zahl zwischen 1 und 52 zurück, die die Kalenderwoche für ein angegebenes Datum darstellt.

Syntax

integer BirtDateTime.week( datum )

Parameter

datum

Ein Datumsobjekt (Date), aus dem der Wert für die Woche abgerufen wird.

Rückgabe

Integer. Die Kalenderwoche für ein angegebenes Datum.

Beispiele

Das folgende Beispiel zeigt, welche Kalenderwochenwerte für bestimmte Daten zurückgegeben werden:

BirtDateTime.week( "2009-02-15" ) // Rückgabewert: 8
BirtDateTime.week( "2009-10-12" ) // Rückgabewert: 42

Das folgende Beispiel gibt den Wochenwert für jeden Wert im Feld 'CloseDate' zurück:

BirtDateTime.week( row["CloseDate"] )

Das folgende Beispiel gibt die Kalenderwoche für das aktuelle Datum zurück:

BirtDateTime.week( (BirtDateTime.today() )

BirtDateTime.weekDay

Diese Funktion gibt den Tag der Woche für ein angegebenes Datum zurück. In Abhängigkeit von der Option, die Sie angeben, gibt die Funktion den Tag der Woche in Form einer Zahl, als vollständigen Wochentag oder als Abkürzung des Wochentags zurück. Der Name des Wochentags ist abhängig von der jeweiligen Ländereinstellung.

Syntax

string BirtDateTime.weekDay( Date datum, integer option )

Parameter

datum

Ein Datumsobjekt (Date), von dem der Tag der Woche abgerufen wird.

option

Integer. Optional. Sie gibt eine Nummer an, die das Format darstellt, in dem der Wochentag zurückgegeben werden soll. Verwenden Sie einen der folgenden Werte:

*
*
*
*
*

Wenn Sie dieses Argument nicht verwenden, so setzt die Funktion die Verwendung der Option 1 voraus.

Rückgabe

String. Der Tag der Woche für ein angegebenes Datum.

Beispiele

Das folgende Beispiel zeigt, welche Wochentagwerte für ein bestimmtes Datum zurückgegeben werden:

BirtDateTime.weekDay( "2009-02-02" ) // Rückgabewert: 2
BirtDateTime.weekDay( "2009-02-02", 2 ) // Rückgabewert: 1
BirtDateTime.weekDay( "2009-02-02", 4 ) // Rückgabewert: Monday (Montag)

Das folgende Beispiel gibt den Tag der Woche für das aktuelle Datum zurück:

BirtDateTime.weekDay( (BirtDateTime.today() )

BirtDateTime.year

Diese Funktion gibt die vierstellige Jahresangabe für ein angegebenes Datum zurück. Wenn das Datum beispielsweise den 19. Januar 2009 ('2009-01-19') vorgibt, so gibt die Funktion den Wert 2009 zurück.

Syntax

integer BirtDateTime.year( datum )

Parameter

datum

Ein Datumsobjekt (Date), von dem das Jahr abgerufen wird.

Rückgabe

Integer. Der aus vier Ziffern bestehende Jahreswert für ein angegebenes Datum.

Beispiele

Das folgende Beispiel gibt das Jahr für jeden Wert im Feld "HireDate" zurück:

BirtDateTime.year( row["HireDate"] )

Das folgende Beispiel gibt das Jahr für das aktuelle Datum zurück:

BirtDateTime.year( (BirtDateTime.today())

(c) Copyright Actuate Corporation 2013