Poprzedni Następny

Klasa BirtDateTime

Klasa BirtDateTime zapewnia funkcje, które pozwalają określić czas między dwiema datami lub dwiema godzinami, dodawać lub odejmować odstępy czasu oraz pobierać elementy daty. Odstępy czasu są zwykłymi liczbami, więc aplikacja może wykonywać na nich normalne działania matematyczne: mnożenie, dzielenie, dodawanie, odejmowanie itd. Jest to klasa statyczna. Aplikacja nie może tworzyć instancji klasy.

BirtDateTime.addDay

Ta funkcja zwraca nową datę będącą wynikiem dodania do daty określonej liczby dni. Liczba dni, które mają być dodane do daty, może być ujemna. Wartość taka jest podczas obliczeń odejmowana od daty bazowej.

Składnia

Date BirtDateTime.addDay( Date data, Number n )

Parametry

data

Obiekt typu Date. Obiekt daty reprezentujący datę początkową.

n

Obiekt Number. Liczba dni, które mają zostać dodane do daty. Liczby dziesiętne są traktowane jako liczby całkowite (są zaokrąglane do zera do najbliższej liczby całkowitej).

Wartości zwracane

Obiekt typu Date. Data będąca wynikiem dodania określonej liczby dni do daty początkowej.

Przykłady

W następującym przykładzie do daty zostanie dodana konkretna liczba dni:

var dataPoczątkowa = "2008-12-31";
var dataKońcowa;
dataKońcowa = BirtDateTime.addDay( dataPoczątkowa, 1 ); // zwraca 1 stycznia 2009 r.
dataKońcowa = BirtDateTime.addDay( dataPoczątkowa, -1 ); // zwraca 30 grudnia 2008 r.

W następującym przykładzie do każdej daty z pola DataFaktury zostanie dodane 15 dni:

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

BirtDateTime.addHour

Ta funkcja zwraca nową datę będącą wynikiem dodania do daty określonej liczby godzin. Liczba godzin, które mają być dodane do daty, może być ujemna. Wartość taka jest podczas obliczeń odejmowana od daty bazowej.

Składnia

Date BirtDateTime.addHour( Date data, Number n )

Parametry

data

Obiekt daty reprezentujący datę początkową. Jeśli data początkowa nie ma wartości godziny, funkcja przyjmuje godzinę 00:00:00 (północ).

n

Obiekt Number. Liczba godzin, które mają zostać dodane do daty.

Wartości zwracane

Obiekt typu Date. Data będąca wynikiem dodania określonej liczby godzin do daty początkowej.

Przykłady

W następującym przykładzie do daty i godziny zostanie dodana konkretna liczba godzin:

var dataPoczątkowa = "2008-12-31 15:00:00";
var dataKońcowa;
endDate = BirtDateTime.addHour( dataPoczątkowa, 8 ); // zwraca 31 grudnia 2008 r., 23:00
endDate = BirtDateTime.addHour( dataPoczątkowa, -8 ); // zwraca 31 grudnia 2008 r., 07:00

W następującym przykładzie do każdej daty z pola GodzinaPoczątkowa zostanie dodane 36 godzin:

BirtDateTime.addHour( row["GodzinaPoczątkowa"], 36 )

BirtDateTime.addMinute

Ta funkcja zwraca nową datę będącą wynikiem dodania do daty określonej liczby minut. Liczba minut, które mają być dodane do daty, może być ujemna. Wartość taka jest podczas obliczeń odejmowana od daty bazowej.

Składnia

Date BirtDateTime.addMinute( Date data, Number n )

Parametry

data

Obiekt daty reprezentujący datę początkową. Jeśli data początkowa nie ma wartości godziny, funkcja przyjmuje godzinę 00:00:00 (północ).

n

Obiekt Number. Liczba minut, które mają zostać dodane do daty.

Wartości zwracane

Obiekt typu Date. Data będąca wynikiem dodania określonej liczby minut do daty początkowej.

Przykłady

W następującym przykładzie do daty i godziny zostanie dodana konkretna liczba minut:

var dataPoczątkowa = "2008-12-31 10:30:00";
var dataKońcowa;
endDate = BirtDateTime.addMinute( dataPoczątkowa, 45 );
// zwraca 31 grudnia 2008 r., 11:15
endDate = BirtDateTime.addMinute( GodzinaPoczątkowa, -30 );
// zwraca 31 grudnia 2008 r., 10:00

W następującym przykładzie do każdej daty z pola GodzinaPoczątkowa zostanie dodane 15 minut:

BirtDateTime.addMinute( row["GodzinaPoczątkowa"], 15 )

BirtDateTime.addMonth

Ta funkcja zwraca nową datę będącą wynikiem dodania do daty określonej liczby miesięcy. Liczba miesięcy, które mają być dodane do daty, może być ujemna. Wartość taka jest podczas obliczeń odejmowana od daty bazowej.

Funkcja zawsze zwraca prawidłową datę. Jeśli jest to konieczne, dzień w zwróconej dacie jest ustalany na ostatni dzień wynikowego miesiąca w wynikowym roku. Na przykład dodanie za pomocą funkcji addMonth( ) jednego miesiąca do 31 stycznia 2008 r. spowoduje zwrócenie 29 lutego 2008 r. (jest to rok przestępny), a nie 31 lutego 2008 r.

Składnia

Date BirtDateTime.addMonth( Date data, Number n )

Parametry

data

Obiekt typu Date. Obiekt daty reprezentujący datę początkową.

n

Obiekt Number. Liczba miesięcy, które mają zostać dodane do daty. Liczby dziesiętne są traktowane jako liczby całkowite (są zaokrąglane do zera).

Wartości zwracane

Obiekt typu Date. Data będąca wynikiem dodania określonej liczby miesięcy do daty początkowej.

Przykłady

W następującym przykładzie do daty zostanie dodana konkretna liczba miesięcy:

var dataPoczątkowa = "2008-12-31";
var dataKońcowa;
endDate = BirtDateTime.addMonth( dataPoczątkowa, 1 ); // zwraca 31 stycznia 2009 r.
endDate = BirtDateTime.addMonth( dataPoczątkowa, -1 ); // zwraca 30 listopada 2008 r.
endDate = BirtDateTime.addMonth( dataPoczątkowa, 2 ); // zwraca 28 lutego 2009 r.

W następującym przykładzie do każdej daty z pola DataFaktury zostanie dodane 10 miesięcy:

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

BirtDateTime.addQuarter

Ta funkcja zwraca nową datę będącą wynikiem dodania do daty określonej liczby kwartałów. Kwartał to trzy miesiące. Na przykład jeśli dodano 2 kwartały do daty 10 wrz 2008, funkcja zwraca wartość 10 mar 2009. Liczba kwartałów, które mają być dodane do daty, może być ujemna. Wartość taka jest podczas obliczeń odejmowana od daty bazowej.

Składnia

Date BirtDateTime.addQuarter( Date data, Number n )

Parametry

data

Obiekt daty reprezentujący datę początkową.

n

Obiekt Number. Liczba kwartałów, które mają zostać dodane do daty.

Wartości zwracane

Obiekt typu Date. Data będąca wynikiem dodania określonej liczby kwartałów do daty początkowej.

Przykłady

W następującym przykładzie do daty zostanie dodana konkretna liczba kwartałów:

var dataPoczątkowa = "2008-12-15";
var dataKońcowa;
dataKońcowa = BirtDateTime.addQuarter( dataPoczątkowa, 1 ); //zwraca 15 marca 2009 r.
dataKońcowa = BirtDateTime.addQuarter( dataPoczątkowa, -2 ); //zwraca 15 czerwca 2008 r.

W następującym przykładzie do każdej daty z pola PrognozowaneZamknięcie zostaną dodane 2 kwartały:

BirtDateTime.addQuarter( row["PrognozowaneZamknięcie"], 2 )

BirtDateTime.addSecond

Ta funkcja zwraca nową datę będącą wynikiem dodania do daty określonej liczby sekund. Liczba sekund, które mają być dodane do daty, może być ujemna. Wartość taka jest podczas obliczeń odejmowana od daty bazowej.

Składnia

Date BirtDateTime.addSecond( Date data, Number n )

Parametry

data

Obiekt daty reprezentujący datę początkową. Jeśli data początkowa nie ma wartości godziny, funkcja przyjmuje godzinę 00:00:00 (północ).

n

Obiekt Number. Liczba sekund, które mają zostać dodane do daty.

Wartości zwracane

Obiekt typu Date. Wynik dodania określonej liczby sekund do daty początkowej.

Przykłady

W następującym przykładzie do daty i godziny zostanie dodana konkretna liczba sekund:

var dataPoczątkowa = "2008-12-31 10:30:00";
var dataKońcowa;
dataKońcowa = BirtDateTime.addSecond( dataPoczątkowa, 10000 );
// zwraca 31 grudnia 2008 r., 13:16:40
dataKońcowa = BirtDateTime.addSecond( dataPoczątkowa, -10000 );
// zwraca 31 grudnia 2008 r., 07:43:20

W następującym przykładzie do każdej daty z pola GodzinaPoczątkowa zostanie dodane 6000 sekund:

BirtDateTime.addSecond( row["GodzinaPoczątkowa"], 6000 )

BirtDateTime.addWeek

Ta funkcja zwraca nową datę będącą wynikiem dodania do daty określonej liczby tygodni. Liczba tygodni, które mają być dodane do daty, może być ujemna. Wartość taka jest podczas obliczeń odejmowana od daty bazowej.

Składnia

Date BirtDateTime.addWeek( Date data, Number n )

Parametry

data

Obiekt daty reprezentujący datę początkową.

n

Obiekt Number. Liczba tygodni, które mają zostać dodane do daty.

Wartości zwracane

Obiekt typu Date. Data będąca wynikiem dodania określonej liczby tygodni do daty początkowej.

Przykłady

W następującym przykładzie do daty została dodana konkretna liczba tygodni:

var dataPoczątkowa = "2008-12-31";
var dataKońcowa;
dataKońcowa = BirtDateTime.addWeek( dataPoczątkowa, 1 ); // zwraca 7 stycznia 2009 r.
dataKońcowa = BirtDateTime.addWeek( dataPoczątkowa, -1 ); // zwraca 24 grudnia 2008 r.

W następującym przykładzie do każdej daty z pola DataFaktury zostaną dodane 2 tygodnie:

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

BirtDateTime.addYear

Ta funkcja zwraca nową datę będącą wynikiem dodania do daty określonej liczby lat. Liczba lat, które mają być dodane do daty, może być ujemna. Wartość taka jest podczas obliczeń odejmowana od daty bazowej.

Składnia

Date BirtDateTime.addYear( Date data, Number n )

Parametry

data

Obiekt daty reprezentujący datę początkową.

n

Obiekt Number. Liczba lat, które mają zostać dodane do daty. Liczby dziesiętne są traktowane jako liczby całkowite (są zaokrąglane do zera).

Wartości zwracane

Data będąca wynikiem dodania określonej liczby lat do daty początkowej.

Przykłady

W następującym przykładzie do daty zostanie dodana konkretna liczba lat:

var dataPoczątkowa = "2008-12-31";
var dataKońcowa;
dataKońcowa = BirtDateTime.addYear( dataPoczątkowa, 1 ); // zwraca 31 grudnia 2009 r.
dataKońcowa = BirtDateTime.addYear( dataPoczątkowa, -1 ); // zwraca 31 grudnia 2007 r.

W następującym przykładzie do każdej daty z pola DataZatrudnienia zostanie dodane 5 lat:

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

BirtDateTime.day

Ta funkcja zwraca liczbę od 1 do 31, która określa dzień miesiąca dla danej daty. Jeśli na przykład data to 2009-01-19, funkcja zwróci wartość 19.

Składnia

integer BirtDateTime.day( Date data )

Parametr

data

Obiekt typu Date. Obiekt daty, z którego ma zostać uzyskana wartość dnia.

Wartości zwracane

Liczba całkowita reprezentująca dzień miesiąca określony przez podaną datę.

Przykłady

Następujący przykład zwraca dzień miesiąca dla każdej wartości w polu DataDostawy:

BirtDateTime.day( row["DataDostawy"] )

Następujący przykład zwraca dzień miesiąca dla bieżącej daty:

BirtDateTime.day( (BirtDateTime.today())

BirtDateTime.diffDay

Ta funkcja zwraca liczbę dni między dwiema datami. Liczba dni jest obliczana przez odjęcie wartości dnia dla pierwszej daty od wartości dnia dla drugiej daty. Jeśli na przykład pierwsza data to 2008-12-30 23:59:59, a druga data to 2008-12-31 00:00:00, funkcja zwróci 1 dzień, mimo że między tymi datami jest tylko jedna sekunda różnicy.

Składnia

integer BirtDateTime.diffDay( Date data1, Date data2 )

Parametry

data1

Obiekt daty reprezentujący początek przedziału czasu.

data2

Obiekt daty reprezentujący koniec przedziału czasu.

Wartości zwracane

Liczba całkowita. Liczba dni między dwiema datami.

Przykłady

Następujący przykład zwraca liczbę dni między konkretnymi datami:

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

Następujący przykład zwraca liczbę dni między datą bieżącą i końcem 2009 r.:

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

Następujący przykład zwraca liczbę dni między wartościami w polach DataFaktury i DataPłatności:

BirtDateTime.diffDay( row["DataFaktury"], row["DataPłatności"] )

BirtDateTime.diffHour

Ta funkcja zwraca liczbę godzin między dwiema datami. Liczba godzin jest obliczana przez odjęcie wartości godziny dla pierwszej daty od wartości godziny dla drugiej daty. Jeśli na przykład pierwsza data to 2009-01-31 1:30:00, a druga data to 2009-01-31 2:00:00, funkcja zwróci 1 godzinę, mimo że między tymi datami jest tylko 30 minut różnicy. Jeśli data nie ma wartości godziny, funkcja przyjmuje godzinę 00:00:00 (północ).

Składnia

integer BirtDateTime.diffHour( Date data1, Date data2 )

Parametry

data1

Obiekt daty reprezentujący początek przedziału czasu.

data2

Obiekt daty reprezentujący koniec przedziału czasu.

Wartości zwracane

Liczba całkowita. Liczba godzin między dwiema datami.

Przykłady

Następujący przykład zwraca liczbę godzin między konkretnymi datami:

BirtDateTime.diffHour( "2009-01-31 12:00:00", "2009-02-01 12:00:00")
// zwraca 24
BirtDateTime.diffHour( "2009-01-31", "2009-02-01 12:00:00")
// zwraca 36. Ponieważ w pierwszej dacie nie ma godziny, przyjęto dla niej godzinę 0:00:00 (północ).

Następujący przykład zwraca liczbę godzin między bieżącą datą i godziną a końcem 2009 r.:

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

Następujący przykład zwraca liczbę godzin między wartościami w polach GodzinaPoczątkowa i GodzinaKońcowa:

BirtDateTime.diffHour( row["GodzinaPoczątkowa"], row["GodzinaKońcowa"] )

BirtDateTime.diffMinute

Ta funkcja zwraca liczbę minut między dwiema datami. Liczba minut jest obliczana przez odjęcie wartości minut dla pierwszej daty od wartości minut dla drugiej daty. Jeśli na przykład pierwsza data to 2009-01-31 1:30:59, a druga data to 2009-01-31 1:31:00, funkcja zwróci 1 minutę, mimo że między tymi datami jest tylko jedna sekunda różnicy. Jeśli data nie ma wartości godziny, funkcja przyjmuje godzinę 00:00:00 (północ).

Składnia

integer BirtDateTime.diffMinute( Date data1, Date data2 )

Parametry

data1

Obiekt daty reprezentujący początek przedziału czasu.

data2

Obiekt daty reprezentujący koniec przedziału czasu.

Wartości zwracane

Liczba całkowita. Liczba minut między dwiema datami.

Przykłady

Następujący przykład zwraca liczbę minut między konkretnymi datami:

BirtDateTime.diffMinute( "2009-01-31 1:30:30", "2009-01-31 10:45:00")
// zwraca 555
BirtDateTime.diffMinute( "2009-01-31", "2009-01-31 12:00:00")
// zwraca 720. Ponieważ w pierwszej dacie nie ma godziny, przyjęto dla niej godzinę 0:00:00 (północ).

Następujący przykład zwraca liczbę minut między bieżącą datą i godziną a początkiem 2010 r.:

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

Następujący przykład zwraca liczbę minut między wartościami w polach GodzinaPoczątkowa i GodzinaKońcowa:

BirtDateTime.diffMinute( row["GodzinaPoczątkowa"], row["GodzinaKońcowa"] )

BirtDateTime.diffMonth

Ta funkcja zwraca liczbę miesięcy między dwiema datami. Liczba miesięcy jest obliczana przez odjęcie wartości miesięcy dla pierwszej daty od wartości miesięcy dla drugiej daty. Jeśli na przykład pierwsza data to 2009-01-31, a druga data to 2009-02-01, funkcja zwróci 1 miesiąc, mimo że między tymi datami jest tylko jeden dzień różnicy.

Składnia

integer BirtDateTime.diffMonth( Date data1, Date data2 )

Parametry

data1

Obiekt daty reprezentujący początek przedziału czasu.

data2

Obiekt daty reprezentujący koniec przedziału czasu.

Wartości zwracane

Liczba całkowita. Liczba miesięcy między dwiema datami.

Przykłady

Następujący przykład zwraca liczbę miesięcy między konkretnymi datami:

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

Następujący przykład zwraca liczbę miesięcy między datą bieżącą i początkiem 2010 r.:

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

Następujący przykład zwraca liczbę miesięcy między wartościami w polach PoczątekProjektu i KoniecProjektu:

BirtDateTime.diffMonth( row["PoczątekProjektu"], row["KoniecProjektu"] )

BirtDateTime.diffQuarter

Ta funkcja zwraca liczbę kwartałów między dwiema datami. Liczba kwartałów jest obliczana przez odjęcie wartości miesiąca dla pierwszej daty od wartości miesiąca dla drugiej daty. Różnica trzech miesięcy to różnica jednego kwartału. Jeśli na przykład pierwsza data to 2009-01-31, a druga data to 2009-07-01, funkcja zwróci wartość 2. Jeśli pierwsza data to 2009-01-01, a druga data to 2009-09-30, funkcja także zwróci wartość 2.

Składnia

integer BirtDateTime.diffQuarter( Date data1, Date data2 )

Parametry

data1

Obiekt daty reprezentujący początek przedziału czasu.

data2

Obiekt daty reprezentujący koniec przedziału czasu.

Wartości zwracane

Liczba całkowita. Liczba kwartałów między dwiema datami.

Przykłady

Następujący przykład zwraca liczbę kwartałów między konkretnymi datami:

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

Następujący przykład zwraca liczbę kwartałów między datą bieżącą i początkiem 2010 r.:

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

Następujący przykład zwraca liczbę kwartałów między wartościami w polach PoczątekProjektu i KoniecProjektu:

BirtDateTime.diffQuarter( row["PoczątekProjektu"], row["KoniecProjektu"] )

BirtDateTime.diffSecond

Ta funkcja zwraca liczbę sekund między dwiema datami. Jeśli data nie ma wartości godziny, funkcja przyjmuje godzinę 00:00:00 (północ).

Składnia

integer BirtDateTime.diffSecond( data1, data2 )

Parametry

data1

Obiekt daty reprezentujący początek przedziału czasu.

data2

Obiekt daty reprezentujący koniec przedziału czasu.

Wartości zwracane

Liczba całkowita. Liczba sekund między dwiema datami.

Przykłady

Następujący przykład zwraca liczbę sekund między konkretnymi datami:

BirtDateTime.diffSecond( "2009-01-31 11:30:30", "2009-01-31 12:00:00")
// zwraca 1770
BirtDateTime.diffSecond( "2009-01-31", "2009-01-31 1:00:00")
// zwraca 3600. Ponieważ w pierwszej dacie nie ma godziny, przyjęto dla niej godzinę 0:00:00 (północ).

Następujący przykład zwraca liczbę sekund między bieżącą datą i godziną a początkiem 2010 r.:

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

Następujący przykład zwraca liczbę sekund między wartościami w polach GodzinaPoczątkowa i GodzinaKońcowa:

BirtDateTime.diffSecond( row["GodzinaPoczątkowa"], row["GodzinaKońcowa"] )

BirtDateTime.diffWeek

Ta funkcja zwraca liczbę tygodni między dwiema datami. Tydzień jest obliczany przez odjęcie numeru tygodnia pierwszej daty od numeru tygodnia drugiej daty. Jeśli na przykład pierwsza data to 2009-01-02 (pierwszy tydzień roku) a druga data to 2009-01-05 (drugi tydzień roku), funkcja zwróci 1 tydzień, mimo że między tymi datami są tylko trzy dni różnicy.

Składnia

integer BirtDateTime.diffWeek( Date data1, Date data2 )

Parametry

data1

Obiekt daty reprezentujący początek przedziału czasu.

data2

Obiekt daty reprezentujący koniec przedziału czasu.

Wartości zwracane

Liczba całkowita. Liczba tygodni między dwiema datami.

Przykłady

Następujący przykład zwraca liczbę tygodni między konkretnymi datami:

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

Następujący przykład zwraca liczbę tygodni między datą bieżącą i początkiem 2010 r.:

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

Następujący przykład zwraca liczbę tygodni między wartościami w polach PoczątekProjektu i KoniecProjektu:

BirtDateTime.diffWeek( row["PoczątekProjektu"], row["KoniecProjektu"] )

BirtDateTime.diffYear

Ta funkcja zwraca liczbę lat między dwiema datami. Liczba lat jest obliczana przez odjęcie wartości roku dla pierwszej daty od wartości roku dla drugiej daty. Jeśli na przykład pierwsza data to 2009-01-01, a druga data to 2009-12-31, funkcja zwróci wartość 0. Jeśli pierwsza data to 2008-11-15, a druga data to 2009-01-15, funkcja zwróci wartość 1.

Składnia

integer BirtDateTime.diffYear( Date data1, Date data2 )

Parametry

data1

Obiekt daty reprezentujący początek przedziału czasu.

data2

Obiekt daty reprezentujący koniec przedziału czasu.

Wartości zwracane

Liczba całkowita. Liczba lat między dwiema datami.

Przykłady

Następujący przykład zwraca liczbę lat między konkretnymi datami:

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

Następujący przykład zwraca liczbę lat między wartością w polu DataZatrudnienia i datą bieżącą:

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

BirtDateTime.diffYear

Ta funkcja zwraca liczbę lat między dwiema datami. Liczba lat jest obliczana przez odjęcie wartości roku dla pierwszej daty od wartości roku dla drugiej daty. Jeśli na przykład pierwsza data to 2009-01-01, a druga data to 2009-12-31, funkcja zwróci wartość 0. Jeśli pierwsza data to 2008-11-15, a druga data to 2009-01-15, funkcja zwróci wartość 1.

Składnia

integer BirtDateTime.diffYear( Date data1, Date data2 )

Parametry

data1

Obiekt daty reprezentujący początek przedziału czasu.

data2

Obiekt daty reprezentujący koniec przedziału czasu.

Wartości zwracane:

Liczba całkowita. Liczba lat między dwiema datami.

Przykłady

Następujący przykład zwraca liczbę lat między konkretnymi datami:

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

Następujący przykład zwraca liczbę lat między wartością w polu DataZatrudnienia i datą bieżącą:

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

BirtDateTime.firstDayOfMonth

Ta funkcja zwraca datę pierwszego dnia miesiąca, na który przypada data wejściowa.

Składnia

Date BirtDateTime.firstDayOfMonth( Date data )

Parametry

data

Obiekt daty, z którego zostanie uzyskana wartość miesiąca.

Wartości zwracane

Obiekt typu Date. Pierwszy dzień miesiąca określonego przez daną datę.

Przykłady

Następujący przykład pozwala wyświetlić wartość miesiąca dla konkretnej daty:

BirtDateTime.firstDayOfMonth( "2009-02-15" ) // zwraca datę 2009-02-01

BirtDateTime.firstDayOfQuarter

Ta funkcja zwraca datę pierwszego dnia kwartału, na który przypada data wejściowa.

Składnia

Date BirtDateTime.firstDayOfQuarter( Date data )

Parametry

data

Obiekt daty, z którego ma zostać uzyskany kwartał.

Wartości zwracane:

Obiekt typu Date. Pierwszy dzień kwartału określonego przez daną datę.

Przykłady

Następujący przykład pozwala wyświetlić wartość kwartału dla konkretnej daty:

BirtDateTime.firstDayOfQuarter( "2009-02-15" ) // zwraca datę 2009-01-01

BirtDateTime.firstDayOfWeek

Ta funkcja zwraca datę pierwszego dnia tygodnia, na który przypada data wejściowa. Jest to zawsze niedziela.

Składnia

Date BirtDateTime.firstDayOfWeek( Date data )

Parametry

data

Obiekt daty, z którego zostanie uzyskana wartość tygodnia.

Wartości zwracane:

Obiekt typu Date. Pierwszy dzień tygodnia określonego przez daną datę.

Przykłady

Następujący przykład pozwala wyświetlić wartość tygodnia dla konkretnej daty:

BirtDateTime.firstDayOfWeek( "2009-02-15" ) // zwraca datę 2009-02-15

BirtDateTime.firstDayOfYear

Ta funkcja zwraca datę pierwszego dnia roku, na który przypada data wejściowa.

Składnia

Date BirtDateTime.firstDayOfYear( Date data )

Parametry

data

Obiekt daty, z którego ma zostać uzyskany rok.

Wartości zwracane:

Obiekt typu Date. Pierwszy dzień roku określonego przez daną datę.

Przykłady

Następujący przykład pozwala wyświetlić wartość roku dla konkretnej daty:

BirtDateTime.firstDayOfYear( "2009-02-15" ) // zwraca datę 2009-01-01

BirtDateTime.month

Ta funkcja zwraca wartość miesiąca dla danej daty. W zależności od wprowadzonej opcji funkcja zwraca miesiąc jako liczbę, pełną nazwę lub skróconą nazwę. Zwrócona nazwa miesiąca zależy od ustawień narodowych.

Składnia

string BirtDateTime.month( Date data, integer opcja )

Parametry

data

Obiekt daty, z którego zostanie uzyskana wartość miesiąca.

opcja

Liczba całkowita. Właściwość opcjonalna. Liczba, która określa zwracany format miesiąca. Należy użyć jednej z następujących wartości:

*
*
*

Pominięcie tego argumentu oznacza, że funkcja zwróci miesiąc jako liczbę.

Wartości zwracane:

Łańcuch. Miesiąc dla danej daty.

Przykłady

Następujący przykład pozwala wyświetlić wartość miesiąca dla konkretnej daty:

BirtDateTime.month( "2009-02-15" ) // zwraca 2
BirtDateTime.month( "2009-02-15", 2 ) // zwraca "luty"
BirtDateTime.month( "2009-02-15", 3) // zwraca "lut"

Następujący przykład zwraca miesiąc dla bieżącej daty:

BirtDateTime.month( (BirtDateTime.today() )

BirtDateTime.now

Ta funkcja pozwala wyświetlić bieżącą datę i godzinę, np. 2 lutego 2009 r. 14:05.

Składnia

Date BirtDateTime.now( )

Wartości zwracane

Obiekt typu Date. Bieżąca data i godzina.

Przykład

Następujący przykład zwraca liczbę godzin między bieżącą datą i godziną a pierwszym dniem świąt Bożego Narodzenia:

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

BirtDateTime.quarter

Ta funkcja zwraca liczbę od 1 do 4 określającą kwartał, w którym przypada dana data. Pierwszy kwartał rozpoczyna się 1. stycznia.

Składnia

integer BirtDateTime.quarter( Date data )

Parametr

data

Obiekt daty, z którego zostanie uzyskany numer kwartału.

Wartości zwracane

Liczba całkowita. Numer kwartału dla danej daty.

Przykłady

Następujący przykład zwraca numer kwartału dla konkretnych dat:

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

Następujący przykład zwraca numer kwartału dla każdej wartości w polu DataZamknięcia:

BirtDateTime.quarter( row["DataZamknięcia"] )

Następujący przykład zwraca numer kwartału dla bieżącej daty:

BirtDateTime.quarter( (BirtDateTime.today() )

BirtDateTime.today

Ta funkcja pozwala wyświetlić bieżącą datę, dla której jako godzinę przyjęto północ, na przykład 2 lutego 2009 r., 00:00.

Składnia

Date BirtDateTime.today( )

Wartości zwracane

Obiekt typu Date. Bieżąca data z godziną określającą północ.

Przykłady

Następujący przykład zwraca liczbę dni między datą bieżącą i pierwszym dniem świąt Bożego Narodzenia:

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

Następujący przykład służy do obliczania liczby lat między każdą wartością w polu DataZatrudnienia i datą bieżącą.

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

BirtDateTime.week

Ta funkcja zwraca liczbę od 1 do 52, która określa tydzień dla danej daty.

Składnia

integer BirtDateTime.week( data )

Parametr

data

Obiekt daty, z którego ma zostać uzyskany numer tygodnia.

Wartości zwracane:

Liczba całkowita. Numer tygodnia dla danej daty.

Przykłady

Następujący przykład zwraca numer tygodnia dla konkretnych dat:

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

Następujący przykład zwraca numer tygodnia dla każdej wartości w polu DataZamknięcia:

BirtDateTime.week( row["DataZamknięcia"] )

Następujący przykład zwraca numer tygodnia dla bieżącej daty:

BirtDateTime.week( (BirtDateTime.today() )

BirtDateTime.weekDay

Ta funkcja zwraca wartość numeru dnia w tygodniu dla określonej daty. W zależności od wprowadzonej opcji funkcja zwraca dzień tygodnia jako liczbę, pełną nazwę dnia lub skróconą nazwę dnia. Zwrócona nazwa dnia zależy od ustawień narodowych.

Składnia

string BirtDateTime.weekDay( Date data, integer opcja )

Parametry

data

Obiekt daty, z którego zostanie uzyskana wartość dnia tygodnia.

opcja

Liczba całkowita. Właściwość opcjonalna. Liczba, która określa zwracany format dnia. Należy użyć jednej z następujących wartości:

*
*
*
*
*

Pominięcie tego argumentu oznacza, że zostanie przyjęta wartość 1.

Wartości zwracane

Łańcuch. Dzień tygodnia dla podanej daty.

Przykłady

Następujący przykład pozwala wyświetlić wartość dnia tygodnia dla konkretnej daty:

BirtDateTime.weekDay( "2009-02-02" ) // zwraca 2
BirtDateTime.weekDay( "2009-02-02", 2 ) // zwraca 1
BirtDateTime.weekDay( "2009-02-02", 4 ) // zwraca "poniedziałek"

Następujący przykład zwraca dzień tygodnia dla bieżącej daty:

BirtDateTime.weekDay( (BirtDateTime.today() )

BirtDateTime.year

Ta funkcja zwraca czterocyfrową wartość roku dla danej daty. Jeśli na przykład data to 2009-01-19, funkcja zwróci wartość 2009.

Składnia

integer BirtDateTime.year( data )

Parametr

data

Obiekt daty, z którego zostanie uzyskana wartość roku.

Wartości zwracane

Liczba całkowita. Rok w postaci czterocyfrowej dla danej daty.

Przykłady

Następujący przykład zwraca rok dla każdej wartości w polu DataZatrudnienia:

BirtDateTime.year( row["DataZatrudnienia"] )

Następujący przykład zwraca rok dla bieżącej daty:

BirtDateTime.year( (BirtDateTime.today())

(c) Copyright Actuate Corporation 2013