Edellinen Seuraava

BirtDateTime-luokka

BirtDateTime-luokan funktioiden avulla voit selvittää kahden päivämäärän tai kellonajan välisen ajanjakson pituuden, lisätä tai vähentää ajanjaksoja ja noutaa päivämäärän osia. Koska päivämäärien ajanjaksot ovat numeroita, sovellus voi käyttää niissä tavallisia matemaattisia toimintoja, kuten kerto-, jako-, yhteen- ja vähennyslaskua. Tämä luokka on staattinen. Sovellus ei voi luoda luokan ilmentymiä.

BirtDateTime.addDay

Tämä funktio palauttaa uuden päivämäärän, joka muodostetaan lisäämällä aloituspäivään annetut päivät. Lisättävien päivien määrä voi olla negatiivinen. Tässä tapauksessa tulos on sama kuin jos määritetty luku olisi vähennetty päivämäärästä.

Syntaksi

Päivämäärä BirtDateTime.addDay( Päivämäärä [pvm], Luku [n] )

Parametrit

pvm

Päivämääräobjekti. Päivämääräobjekti, joka kuvaa päivämäärää.

n

Lukuobjekti. Päivämäärään lisättävien päivien määrä. Järjestelmä käsittelee desimaalilukuja kokonaislukuina (se pyöristää ne alaspäin lähimpään kokonaislukuun).

Palautukset

Päivämääräobjekti. Päivämäärä, joka muodostetaan lisäämällä määritetyt päivät aloituspäivään.

Esimerkkejä

Seuraavassa esimerkissä määritettyyn päivämäärään lisätään kaksi päivää:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addDay( startDate, 1 ); // palauttaa päivämäärän 1.1.2009
endDate = BirtDateTime.addDay( startDate, -1 ); // palauttaa päivämäärän 30.12.2008

Seuraavassa esimerkissä lisätään 15 päivää kuhunkin InvoiceDate-kentän päivämääräarvoon:

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

BirtDateTime.addHour

Tämä funktio palauttaa uuden päivämäärän, joka muodostetaan lisäämällä aloituspäivään annetut tunnit. Lisättävien tuntien määrä voi olla negatiivinen. Tässä tapauksessa tulos on sama kuin jos määritetty luku olisi vähennetty päivämäärästä.

Syntaksi

Päivämäärä BirtDateTime.addHour( Päivämäärä [pvm], Luku [n] )

Parametrit

pvm

Päivämääräobjekti, joka kuvaa päivämäärää. Jos aloituspäivämäärässä ei ole kellonaika-arvoa, funktio käyttää oletusarvon mukaan kellonaikana keskiyötä (00:00:00).

n

Lukuobjekti. Päivämäärään lisättävien tuntien määrä.

Palautukset

Päivämääräobjekti. Päivämäärä, joka muodostetaan lisäämällä määritetyt tunnit aloituspäivään.

Esimerkkejä

Seuraavassa esimerkissä päivämäärään ja kellonaikaan lisätään tunteja:

var startDate = "2008-12-31 15:00:00";
var endDate;
endDate = BirtDateTime.addHour( startDate, 8 ); // palauttaa päivämäärän 31.12.2008 ja kellonajan 23.00
endDate = BirtDateTime.addHour( startDate, -8 ); // palauttaa päivämäärän 31.12.2008 ja kellonajan 7.00

Seuraavassa esimerkissä lisätään 36 tuntia kuhunkin StartTime-kentän päivämääräarvoon:

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

BirtDateTime.addMinute

Tämä funktio palauttaa uuden päivämäärän, joka muodostetaan lisäämällä aloituspäivään annetut minuutit. Lisättävien minuuttien määrä voi olla negatiivinen. Tässä tapauksessa tulos on sama kuin jos määritetty luku olisi vähennetty päivämäärästä.

Syntaksi

Päivämäärä BirtDateTime.addMinute( Päivämäärä [pvm], Luku [n] )

Parametrit

pvm

Päivämääräobjekti, joka kuvaa päivämäärää. Jos aloituspäivämäärässä ei ole kellonaika-arvoa, funktio käyttää oletusarvon mukaan kellonaikana keskiyötä (00:00:00).

n

Lukuobjekti. Päivämäärään lisättävien minuuttien määrä.

Palautukset

Päivämääräobjekti. Päivämäärä, joka muodostetaan lisäämällä määritetyt minuutit aloituspäivään.

Esimerkkejä

Seuraavassa esimerkissä päivämäärään ja kellonaikaan lisätään minuutteja:

var startDate = "2008-12-31 10:30:00";
var endDate;
endDate = BirtDateTime.addMinute( startDate, 45 );
// palauttaa päivämäärän 31.12.2008 ja kellonajan 11.15
endDate = BirtDateTime.addMinute( startDate, -30 );
// palauttaa päivämäärän 31.12.2008 ja kellonajan 10.00

Seuraavassa esimerkissä lisätään 15 minuuttia kuhunkin StartTime-kentän päivämääräarvoon:

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

BirtDateTime.addMonth

Tämä funktio palauttaa uuden päivämäärän, joka muodostetaan lisäämällä aloituspäivään annetut kuukaudet. Lisättävien kuukausien määrä voi olla negatiivinen. Tässä tapauksessa tulos on sama kuin jos määritetty luku olisi vähennetty päivämäärästä.

Tämä funktio palauttaa aina kelvollisen päivämäärän. Tulospäivämäärän päivämääräosa aikaistetaan tarvittaessa tulosvuoden tuloskuukauden viimeiseksi päivämääräksi. Jos esimerkiksi lisäät yhden kuukauden päivämäärään 31.12.2008, addMonth( )-funktio palauttaa päivämäärän 29.2.2008 (2008 on karkausvuosi), ei päivämäärää 31.2.2008.

Syntaksi

Päivämäärä BirtDateTime.addMonth( Päivämäärä [pvm], Luku [n] )

Parametrit

pvm

Päivämääräobjekti. Päivämääräobjekti, joka kuvaa päivämäärää.

n

Lukuobjekti. Päivämäärään lisättävien kuukausien määrä. Järjestelmä käsittelee desimaalilukuja kokonaislukuina (se pyöristää ne alaspäin).

Palautukset

Päivämääräobjekti. Päivämäärä, joka muodostetaan lisäämällä määritetyt kuukaudet aloituspäivään.

Esimerkkejä

Seuraavassa esimerkissä määritettyyn päivämäärään lisätään kuukausia:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addMonth( startDate, 1 ); // palauttaa päivämäärän 31.1.2009
endDate = BirtDateTime.addMonth( startDate, -1 ); // palauttaa päivämäärän 30.11.2008
endDate = BirtDateTime.addMonth( startDate, 2 ); // palauttaa päivämäärän 28.2.2009

Seuraavassa esimerkissä lisätään 10 kuukautta kuhunkin InvoiceDate-kentän päivämääräarvoon:

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

BirtDateTime.addQuarter

Tämä funktio palauttaa uuden päivämäärän, joka muodostetaan lisäämällä aloituspäivään annetut vuosineljännekset. Vuosineljännes on kolmen kuukauden pituinen. Jos esimerkiksi lisäät kaksi vuosineljännestä päivämäärään 10.9.2008, funktio palauttaa päivämäärän 10.3.2009. Lisättävien vuosineljännesten määrä voi olla negatiivinen. Tässä tapauksessa tulos on sama kuin jos määritetty luku olisi vähennetty päivämäärästä.

Syntaksi

Päivämäärä BirtDateTime.addQuarter( Päivämäärä [pvm], Luku [n] )

Parametrit

pvm

Päivämääräobjekti, joka kuvaa päivämäärää.

n

Lukuobjekti. Päivämäärään lisättävien vuosineljännesten määrä.

Palautukset

Päivämääräobjekti. Päivämäärä, joka muodostetaan lisäämällä määritetyt vuosineljännekset aloituspäivään.

Esimerkkejä

Seuraavassa esimerkissä määritettyyn päivämäärään lisätään vuosineljänneksiä:

var startDate = "2008-12-15";
var endDate;
endDate = BirtDateTime.addQuarter( startDate, 1 ); //palauttaa päivämäärän 15.3.2009
endDate = BirtDateTime.addQuarter( startDate, -2 ); //palauttaa päivämäärän 15.6.2008

Seuraavassa esimerkissä lisätään kaksi vuosineljännestä kuhunkin ForecastClosing-kentän päivämääräarvoon:

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

BirtDateTime.addSecond

Tämä funktio palauttaa uuden päivämäärän, joka muodostetaan lisäämällä aloituspäivään annetut sekunnit. Lisättävien sekuntien määrä voi olla negatiivinen. Tässä tapauksessa tulos on sama kuin jos määritetty luku olisi vähennetty päivämäärästä.

Syntaksi

Päivämäärä BirtDateTime.addSecond( Päivämäärä [pvm], Luku [n] )

Parametrit

pvm

Päivämääräobjekti, joka kuvaa päivämäärää. Jos aloituspäivämäärässä ei ole kellonaika-arvoa, funktio käyttää oletusarvon mukaan kellonaikana keskiyötä (00:00:00).

n

Lukuobjekti. Päivämäärään lisättävien sekuntien määrä.

Palautukset

Päivämääräobjekti. Tulos, joka saadaan lisäämällä määritetyt sekunnit aloituspäivään.

Esimerkkejä

Seuraavassa esimerkissä päivämäärään ja kellonaikaan lisätään sekunteja:

var startDate = "2008-12-31 10:30:00";
var endDate;
endDate = BirtDateTime.addSecond( startDate, 10000 );
// palauttaa päivämäärän 31.12.2008 ja kellonajan 13.16.40
endDate = BirtDateTime.addSecond( startDate, -10000 );
// palauttaa päivämäärän 31.12.2008 ja kellonajan 7.43.20

Seuraavassa esimerkissä lisätään 6 000 sekuntia kuhunkin StartTime-kentän päivämääräarvoon:

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

BirtDateTime.addWeek

Tämä funktio palauttaa uuden päivämäärän, joka muodostetaan lisäämällä aloituspäivään annetut viikot. Lisättävien viikkojen määrä voi olla negatiivinen. Tässä tapauksessa tulos on sama kuin jos määritetty luku olisi vähennetty päivämäärästä.

Syntaksi

Päivämäärä BirtDateTime.addWeek( Päivämäärä [pvm], Luku [n] )

Parametrit

pvm

Päivämääräobjekti, joka kuvaa päivämäärää.

n

Lukuobjekti. Päivämäärään lisättävien viikkojen määrä.

Palautukset

Päivämääräobjekti. Päivämäärä, joka muodostetaan lisäämällä määritetyt viikot aloituspäivään.

Esimerkkejä

Seuraavassa esimerkissä määritettyyn päivämäärään lisätään viikkoja:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addWeek( startDate, 1 ); // palauttaa päivämäärän 7.1.2009
endDate = BirtDateTime.addWeek( startDate, -1 ); // palauttaa päivämäärän 24.12.2008

Seuraavassa esimerkissä lisätään kaksi viikkoa kuhunkin InvoiceDate-kentän päivämääräarvoon:

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

BirtDateTime.addYear

Tämä funktio palauttaa uuden päivämäärän, joka muodostetaan lisäämällä aloituspäivään annetut vuodet. Lisättävien vuosien määrä voi olla negatiivinen. Tässä tapauksessa tulos on sama kuin jos määritetty luku olisi vähennetty päivämäärästä.

Syntaksi

Päivämäärä BirtDateTime.addYear( Päivämäärä [pvm], Luku [n] )

Parametrit

pvm

Päivämääräobjekti, joka kuvaa päivämäärää.

n

Lukuobjekti. Päivämäärään lisättävien vuosien määrä. Järjestelmä käsittelee desimaalilukuja kokonaislukuina (se pyöristää ne alaspäin).

Palautukset

Päivämäärä, joka muodostetaan lisäämällä määritetyt vuodet aloituspäivään.

Esimerkkejä

Seuraavassa esimerkissä määritettyyn päivämäärään lisätään vuosia:

var startDate = "2008-12-31";
var endDate;
endDate = BirtDateTime.addYear( startDate, 1 ); // palauttaa päivämäärän 31.12.2009
endDate = BirtDateTime.addYear( startDate, -1 ); // palauttaa päivämäärän 31.12.2007

Seuraavassa esimerkissä lisätään viisi vuotta kuhunkin HireDate-kentän päivämääräarvoon:

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

BirtDateTime.day

Tämä funktio palauttaa luvun 1 - 31, joka vastaa määritetyn päivämäärän kuukaudenpäivää. Jos päivämäärä on esimerkiksi 19.1.2009, funktio palauttaa luvun 19.

Syntaksi

kokonaisluku BirtDateTime.day( Päivämäärä [pvm] )

Parametri

pvm

Päivämääräobjekti. Päivämääräobjekti, josta päivä noudetaan.

Palautukset

Määritetyn päivämäärän kuukaudenpäivää vastaava kokonaisluku.

Esimerkkejä

Seuraava esimerkki palauttaa kuukaudenpäivän kustakin ShipDate-kentän arvosta:

BirtDateTime.day( row["ShipDate"] )

Seuraava esimerkki palauttaa kuluvan päivämäärän kuukaudenpäivän:

BirtDateTime.day( (BirtDateTime.today())

BirtDateTime.diffDay

Tämä funktio palauttaa kahden päivämäärän välisten päivien määrän. Määrä lasketaan vähentämällä ensimmäisen päivämääräarvon päiväosa toisen päivämääräarvon päiväosasta. Jos ensimmäinen päivämäärä on esimerkiksi 30.12.2008 (23.59.59.) ja toinen 31.12.2008 (00.00.00), funktio palauttaa yhden päivän, vaikka päivämääräarvojen aikaväli on vain yksi sekunti.

Syntaksi

kokonaisluku BirtDateTime.diffDay( Päivämäärä [pvm1], Päivämäärä [pvm2] )

Parametrit

pvm1

Päivämääräobjekti, joka määrittää aikavälin alun.

pvm2

Päivämääräobjekti, joka määrittää aikavälin lopun.

Palautukset

Kokonaisluku. Kahden päivämäärän välisten päivien määrä.

Esimerkkejä

Seuraava esimerkki palauttaa määritettyjen päivämäärien välisten päivien määrän:

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

Seuraava esimerkki palauttaa kuluvan päivämäärän ja vuoden 2009 lopun välisten päivien määrän:

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

Seuraava esimerkki palauttaa InvoiceDate- ja PaymentDate-kenttien arvojen välisten päivien määrän:

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

BirtDateTime.diffHour

Tämä funktio palauttaa kahden päivämäärän välisten tuntien määrän. Tuntilukema lasketaan vähentämällä ensimmäisen päivämääräarvon tuntiosa toisen päivämääräarvon tuntiosasta. Jos ensimmäinen päivämäärä on esimerkiksi 31.1.2009 (1.30.00.) ja toinen 31.1.2009 (2.00.00), funktio palauttaa yhden tunnin, vaikka päivämääräarvojen aikaväli on vain 30 minuuttia. Jos päivämäärässä ei ole kellonaika-arvoa, funktio käyttää oletusarvon mukaan kellonaikana keskiyötä (00.00.00).

Syntaksi

kokonaisluku BirtDateTime.diffHour( Päivämäärä [pvm1], Päivämäärä [pvm2] )

Parametrit

pvm1

Päivämääräobjekti, joka määrittää aikavälin alun.

pvm2

Päivämääräobjekti, joka määrittää aikavälin lopun.

Palautukset

Kokonaisluku. Kahden päivämäärän välisten tuntien määrä.

Esimerkkejä

Seuraava esimerkki palauttaa määritettyjen päivämäärien välisten tuntien määrän:

BirtDateTime.diffHour( "2009-01-31 12:00:00", "2009-02-01 12:00:00")
// palauttaa luvun 24
BirtDateTime.diffHour( "2009-01-31", "2009-02-01 12:00:00")
// palauttaa luvun 36. Koska ensimmäisessä päiväämärässä ei ole kellonaikaa, funktio käyttää oletusarvona keskiyötä.

Seuraava esimerkki palauttaa kuluvan päivämäärän ja vuoden 2009 lopun välisten tuntien määrän:

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

Seuraava esimerkki palauttaa StartTime- ja FinishTime-kenttien arvojen välisten tuntien määrän:

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

BirtDateTime.diffMinute

Tämä funktio palauttaa kahden päivämäärän välisten minuuttien määrän. Minuuttilukema lasketaan vähentämällä ensimmäisen päivämääräarvon minuuttiosa toisen päivämääräarvon minuuttiosasta. Jos ensimmäinen päivämäärä on esimerkiksi 31.1.2009 (1.30.59.) ja toinen 31.1.2009 (1.31.00), funktio palauttaa yhden minuutin, vaikka päivämääräarvojen aikaväli on vain yksi sekunti. Jos päivämäärässä ei ole kellonaika-arvoa, funktio käyttää oletusarvon mukaan kellonaikana keskiyötä (00.00.00).

Syntaksi

kokonaisluku BirtDateTime.diffMinute( Päivämäärä [pvm1], Päivämäärä [pvm2] )

Parametrit

pvm1

Päivämääräobjekti, joka määrittää aikavälin alun.

pvm2

Päivämääräobjekti, joka määrittää aikavälin lopun.

Palautukset

Kokonaisluku. Kahden päivämäärän välisten minuuttien määrä.

Esimerkkejä

Seuraava esimerkki palauttaa määritettyjen päivämäärien välisten minuuttien määrän:

BirtDateTime.diffMinute( "2009-01-31 1:30:30", "2009-01-31 10:45:00")
// palauttaa luvun 555
BirtDateTime.diffMinute( "2009-01-31", "2009-01-31 12:00:00")
// palauttaa luvun 720. Koska ensimmäisessä päiväämärässä ei ole kellonaikaa, funktio käyttää oletusarvona keskiyötä.

Seuraava esimerkki palauttaa kuluvan päivämäärän ja vuoden 2010 alun välisten minuuttien määrän:

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

Seuraava esimerkki palauttaa StartTime- ja FinishTime-kenttien arvojen välisten minuuttien määrän:

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

BirtDateTime.diffMonth

Tämä funktio palauttaa kahden päivämäärän välisten kuukausien määrän. Kuukausilukema lasketaan vähentämällä ensimmäisen päivämääräarvon kuukausiosa toisen päivämääräarvon kuukausiosasta. Jos ensimmäinen päivämäärä on esimerkiksi 31.1.2009 ja toinen 1.2.2009, funktio palauttaa yhden kuukauden, vaikka päivämääräarvojen aikaväli on vain yksi päivä.

Syntaksi

kokonaisluku BirtDateTime.diffMonth( Päivämäärä [pvm1], Päivämäärä [pvm2] )

Parametrit

pvm1

Päivämääräobjekti, joka määrittää aikavälin alun.

pvm2

Päivämääräobjekti, joka määrittää aikavälin lopun.

Palautukset

Kokonaisluku. Kahden päivämäärän välisten kuukausien määrä.

Esimerkkejä

Seuraava esimerkki palauttaa määritettyjen päivämäärien välisten kuukausien määrän:

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

Seuraava esimerkki palauttaa kuluvan päivämäärän ja vuoden 2010 alun välisten kuukausien määrän:

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

Seuraava esimerkki palauttaa ProjectStart- ja ProjectComplete-kenttien arvojen välisten kuukausien määrän:

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

BirtDateTime.diffQuarter

Tämä funktio palauttaa kahden päivämäärän välisten vuosineljännesten määrän. Vuosineljänneslukema lasketaan vähentämällä ensimmäisen päivämääräarvon kuukausiosa toisen päivämääräarvon kuukausiosasta. Kolmen kuukauden ero vastaa yhtä vuosineljännestä. Jos ensimmäinen päivämäärä on esimerkiksi 31.1.2009 ja toinen 1.7.2009, funktio palauttaa luvun 2. Jos ensimmäinen päivämäärä on 1.1.2009 ja toinen 30.9.2009, funktio palauttaa luvun 2.

Syntaksi

kokonaisluku BirtDateTime.diffQuarter( Päivämäärä [pvm1], Päivämäärä [pvm2] )

Parametrit

pvm1

Päivämääräobjekti, joka määrittää aikavälin alun.

pvm2

Päivämääräobjekti, joka määrittää aikavälin lopun.

Palautukset

Kokonaisluku. Kahden päivämäärän välisten vuosineljännesten määrä.

Esimerkkejä

Seuraava esimerkki palauttaa määritettyjen päivämäärien välisten vuosineljännesten määrän:

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

Seuraava esimerkki palauttaa kuluvan päivämäärän ja vuoden 2010 alun välisten vuosineljännesten määrän:

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

Seuraava esimerkki palauttaa ProjectStart- ja ProjectComplete-kenttien arvojen välisten vuosineljännesten määrän:

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

BirtDateTime.diffSecond

Tämä funktio palauttaa kahden päivämäärän välisten sekuntien määrän. Jos päivämäärässä ei ole kellonaika-arvoa, funktio käyttää oletusarvon mukaan kellonaikana keskiyötä (00.00.00).

Syntaksi

kokonaisluku BirtDateTime.diffSecond( pvm1, pvm2 )

Parametrit

pvm1

Päivämääräobjekti, joka määrittää aikavälin alun.

pvm2

Päivämääräobjekti, joka määrittää aikavälin lopun.

Palautukset

Kokonaisluku. Kahden päivämäärän välisten sekuntien määrä.

Esimerkkejä

Seuraava esimerkki palauttaa määritettyjen päivämäärien välisten sekuntien määrän:

BirtDateTime.diffSecond( "2009-01-31 11:30:30", "2009-01-31 12:00:00")
// palauttaa luvun 1 770
BirtDateTime.diffSecond( "2009-01-31", "2009-01-31 1:00:00")
// palauttaa luvun 3 600. Koska ensimmäisessä päiväämärässä ei ole kellonaikaa, funktio käyttää oletusarvona keskiyötä.

Seuraava esimerkki palauttaa kuluvan päivämäärän ja vuoden 2010 alun välisten sekuntien määrän:

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

Seuraava esimerkki palauttaa StartTime- ja FinishTime-kenttien arvojen välisten sekuntien määrän:

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

BirtDateTime.diffWeek

Tämä funktio palauttaa kahden päivämäärän välisten viikkojen määrän. Viikkolukema lasketaan vähentämällä ensimmäisen päivämääräarvon viikko-osa toisen päivämääräarvon viikko-osasta. Jos ensimmäinen päivämäärä on esimerkiksi 2.1.2009 (vuoden ensimmäinen viikko) ja toinen 5.1.2009 (vuoden toinen viikko), funktio palauttaa yhden viikon, vaikka päivämääräarvojen aikaväli on vain kolme päivää.

Syntaksi

kokonaisluku BirtDateTime.diffWeek( Päivämäärä [pvm1], Päivämäärä [pvm2] )

Parametrit

pvm1

Päivämääräobjekti, joka määrittää aikavälin alun.

pvm2

Päivämääräobjekti, joka määrittää aikavälin lopun.

Palautukset

Kokonaisluku. Kahden päivämäärän välisten viikkojen määrä.

Esimerkkejä

Seuraava esimerkki palauttaa määritettyjen päivämäärien välisten viikkojen määrän:

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

Seuraava esimerkki palauttaa kuluvan päivämäärän ja vuoden 2010 alun välisten viikkojen määrän:

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

Seuraava esimerkki palauttaa ProjectStart- ja ProjectComplete-kenttien arvojen välisten viikkojen määrän:

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

BirtDateTime.diffYear

Tämä funktio palauttaa kahden päivämäärän välisten vuosien määrän. Vuosilukema lasketaan vähentämällä ensimmäisen päivämääräarvon vuosiosa toisen päivämääräarvon vuosiosasta. Jos ensimmäinen päivämäärä on esimerkiksi 1.1.2009 ja toinen 31.12.2009, funktio palauttaa luvun 0. Jos ensimmäinen päivämäärä on 15.11.2008 ja toinen 15.1.2009, funktio palauttaa luvun 1.

Syntaksi

kokonaisluku BirtDateTime.diffYear( Päivämäärä [pvm1], Päivämäärä [pvm2] )

Parametrit

pvm1

Päivämääräobjekti, joka määrittää aikavälin alun.

pvm2

Päivämääräobjekti, joka määrittää aikavälin lopun.

Palautukset

Kokonaisluku. Kahden päivämäärän välisten vuosien määrä.

Esimerkkejä

Seuraava esimerkki palauttaa määritettyjen päivämäärien välisten vuosien määrän:

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

Seuraava esimerkki palauttaa HireDate-kentän arvon ja kuluvan päivän välisten vuosien määrän:

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

BirtDateTime.diffYear

Tämä funktio palauttaa kahden päivämäärän välisten vuosien määrän. Vuosilukema lasketaan vähentämällä ensimmäisen päivämääräarvon vuosiosa toisen päivämääräarvon vuosiosasta. Jos ensimmäinen päivämäärä on esimerkiksi 1.1.2009 ja toinen 31.12.2009, funktio palauttaa luvun 0. Jos ensimmäinen päivämäärä on 15.11.2008 ja toinen 15.1.2009, funktio palauttaa luvun 1.

Syntaksi

kokonaisluku BirtDateTime.diffYear( Päivämäärä [pvm1], Päivämäärä [pvm2] )

Parametrit

pvm1

Päivämääräobjekti, joka määrittää aikavälin alun.

pvm2

Päivämääräobjekti, joka määrittää aikavälin lopun.

Palautukset

Kokonaisluku. Kahden päivämäärän välisten vuosien määrä.

Esimerkkejä

Seuraava esimerkki palauttaa määritettyjen päivämäärien välisten vuosien määrän:

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

Seuraava esimerkki palauttaa HireDate-kentän arvon ja kuluvan päivän välisten vuosien määrän:

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

BirtDateTime.firstDayOfMonth

Tämä funktio palauttaa sen kuukauden ensimmäisen päivän päivämäärän, jonka ajalle syötetty päivämäärä osuu.

Syntaksi

Päivämäärä BirtDateTime.firstDayOfMonth( Päivämäärä [pvm])

Parametrit

pvm

Päivämääräobjekti, josta kuukausi noudetaan.

Palautukset

Päivämääräobjekti. Annetun päivämäärän kuukauden ensimmäinen päivä.

Esimerkkejä

Seuraavassa esimerkissä on määritetyn päivämäärän kuukausiarvo eri palautusmuodoissa:

BirtDateTime.firstDayOfMonth( "2009-02-15" ) // palauttaa päivämäärän 1.2.2009

BirtDateTime.firstDayOfQuarter

Tämä funktio palauttaa sen vuosineljänneksen ensimmäisen päivän päivämäärän, jonka ajalle syötetty päivämäärä osuu.

Syntaksi

Päivämäärä BirtDateTime.firstDayOfQuarter( Päivämäärä [pvm])

Parametrit

pvm

Päivämääräobjekti, josta vuosineljännes noudetaan.

Palautukset

Päivämääräobjekti. Annetun päivämäärän vuosineljänneksen ensimmäinen päivä.

Esimerkkejä

Seuraavassa esimerkissä on määritetyn päivämäärän vuosineljännesarvo eri palautusmuodoissa:

BirtDateTime.firstDayOfQuarter( "2009-02-15" ) // palauttaa päivämäärän 1.1.2009

BirtDateTime.firstDayOfWeek

Tämä funktio palauttaa sen viikon ensimmäisen päivän päivämäärän, jonka ajalle syötetty päivämäärä osuu (viikonpäivä on tällöin aina sunnuntai).

Syntaksi

Päivämäärä BirtDateTime.firstDayOfWeek( Päivämäärä [pvm])

Parametrit

pvm

Päivämääräobjekti, josta viikko noudetaan.

Palautukset

Päivämääräobjekti. Annetun päivämäärän viikon ensimmäinen päivä.

Esimerkkejä

Seuraavassa esimerkissä on määritetyn päivämäärän viikkoarvo eri palautusmuodoissa:

BirtDateTime.firstDayOfWeek( "2009-02-15" ) // palauttaa päivämäärän 15.2.2009

BirtDateTime.firstDayOfYear

Tämä funktio palauttaa sen vuoden ensimmäisen päivän päivämäärän, jonka ajalle syötetty päivämäärä osuu.

Syntaksi

Päivämäärä BirtDateTime.firstDayOfYear( Päivämäärä [pvm])

Parametrit

pvm

Päivämääräobjekti, josta vuosi noudetaan.

Palautukset

Päivämääräobjekti. Annetun päivämäärän vuoden ensimmäinen päivä.

Esimerkkejä

Seuraavassa esimerkissä on määritetyn päivämäärän vuosiarvo eri palautusmuodoissa:

BirtDateTime.firstDayOfYear( "2009-02-15" ) // palauttaa päivämäärän 1.1.2009

BirtDateTime.month

Tämä funktio palauttaa määritetyn päivämäärän mukaisen kuukauden. Funktio palauttaa valinnan mukaan joko kuukauden järjestysnumeron tai kuukauden koko nimen tai nimilyhenteen. Kuukauden nimi määräytyy paikallistunnuksen mukaan.

Syntaksi

merkkijono BirtDateTime.month( Päivämäärä [pvm], kokonaisluku [valinta] )

Parametrit

pvm

Päivämääräobjekti, josta kuukausi noudetaan.

valinta

Kokonaisluku. Valinnainen. Luku, joka määrittää kuukauden palautusmuodon. Käytä jotakin seuraavista arvoista:

*
*
*

Jos argumenttia ei ole määritetty, funktio palauttaa kuukauden lukuna.

Palautukset

Merkkijono. Määritetyn päivämäärän mukainen kuukausi.

Esimerkkejä

Seuraavassa esimerkissä on määritetyn päivämäärän kuukausiarvo eri palautusmuodoissa:

BirtDateTime.month( "2009-02-15" ) // palauttaa luvun 2
BirtDateTime.month( "2009-02-15", 2 ) // palauttaa merkkijonon Helmikuu
BirtDateTime.month( "2009-02-15", 3) // palauttaa merkkijonon Hel

Seuraava esimerkki palauttaa kuluvan päivämäärän kuukauden:

BirtDateTime.month( (BirtDateTime.today() )

BirtDateTime.now

Tämä funktio palauttaa kuluvan päivämäärän ja kellonajan, kuten 2.2.2009 14.05.

Syntaksi

Päivämäärä BirtDateTime.now( )

Palautukset

Päivämääräobjekti. Kuluva päivämäärä ja kellonaika.

Esimerkki

Seuraava esimerkki palauttaa kuluvan päivämäärän ja joulun välisten tuntien määrän:

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

BirtDateTime.quarter

Tämä funktio palauttaa luvun 1 - 4, joka vastaa määritetyn päivämäärän mukaista vuosineljännestä. Ensimmäisen vuosineljänneksen alkamispäivä on 1.1.

Syntaksi

kokonaisluku BirtDateTime.quarter( Päivämäärä [pvm] )

Parametri

pvm

Päivämääräobjekti, josta vuosineljännes noudetaan.

Palautukset

Kokonaisluku. Määritetyn päivämäärän mukainen vuosineljännes.

Esimerkkejä

Seuraavassa esimerkissä on palautettuna määrättyjen päivämäärien mukaiset vuosineljännekset:

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

Seuraava esimerkki palauttaa vuosineljänneksen kustakin CloseDate-kentän arvosta:

BirtDateTime.quarter( row["CloseDate"] )

Seuraava esimerkki palauttaa kuluvan päivämäärän vuosineljänneksen numeron:

BirtDateTime.quarter( (BirtDateTime.today() )

BirtDateTime.today

Tämä funktio palauttaa kuluvan päivämäärän ja keskiyön kellonajan, esimerkiksi 2.2.2009 00.00.

Syntaksi

Päivämäärä BirtDateTime.today( )

Palautukset

Päivämääräobjekti. Kuluva päivämäärä ja keskiyön kellonaika.

Esimerkkejä

Seuraava esimerkki palauttaa kuluvan päivämäärän ja joulun välisten päivien määrän:

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

Seuraava esimerkki palauttaa HireDate-kentän kunkin arvon ja kuluvan päivän välisten vuosien määrät:

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

BirtDateTime.week

Tämä funktio palauttaa luvun 1 - 52, joka vastaa määritetyn päivämäärän mukaisen viikon järjestysnumeroa.

Syntaksi

kokonaisluku BirtDateTime.week( pvm )

Parametri

pvm

Päivämääräobjekti, josta viikon numero noudetaan.

Palautukset

Kokonaisluku. Määritetyn päivämäärän mukainen viikon numero.

Esimerkkejä

Seuraavassa esimerkissä on palautettuna määrättyjen päivämäärien mukaiset viikkojen numerot:

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

Seuraava esimerkki palauttaa viikon numeron kustakin CloseDate-kentän arvosta:

BirtDateTime.week( row["CloseDate"] )

Seuraava esimerkki palauttaa kuluvan päivämäärän viikon numeron:

BirtDateTime.week( (BirtDateTime.today() )

BirtDateTime.weekDay

Tämä funktio palauttaa määritetyn päivämäärän mukaisen viikonpäivän. Funktio palauttaa valinnan mukaan joko viikonpäivän järjestysnumeron tai viikonpäivän koko nimen tai nimilyhenteen. Viikonpäivän nimi määräytyy paikallistunnuksen mukaan.

Syntaksi

merkkijono BirtDateTime.weekDay( Päivämäärä [pvm], kokonaisluku [valinta] )

Parametrit

pvm

Päivämääräobjekti, josta viikonpäivä noudetaan.

valinta

Kokonaisluku. Valinnainen. Luku, joka määrittää palautusmuodon. Käytä jotakin seuraavista arvoista:

*
*
*
*
*

Jos argumenttia ei ole määritetty, funktio toimii valinnan 1 mukaisesti.

Palautukset

Merkkijono. Määritetyn päivämäärän mukainen päivä.

Esimerkkejä

Seuraavassa esimerkissä on määritetyn päivämäärän viikonpäiväarvo eri palautusmuodoissa:

BirtDateTime.weekDay( "2009-02-02" ) // palauttaa luvun 2
BirtDateTime.weekDay( "2009-02-02", 2 ) // palauttaa luvun 1
BirtDateTime.weekDay( "2009-02-02", 4 ) // palauttaa merkkijonon Maanantai

Seuraava esimerkki palauttaa kuluvan päivämäärän viikonpäivän:

BirtDateTime.weekDay( (BirtDateTime.today() )

BirtDateTime.year

Tämä funktio palauttaa määritetyn päivämäärän mukaisen vuoden neljän numeron pituisena. Jos päivämäärä on esimerkiksi 19.1.2009, funktio palauttaa arvon 2009.

Syntaksi

kokonaisluku BirtDateTime.year( pvm )

Parametri

pvm

Päivämääräobjekti, josta vuosi noudetaan.

Palautukset

Kokonaisluku. Määritetyn päivämäärän vuosi neljän numeron pituisena.

Esimerkkejä

Seuraava esimerkki palauttaa HireDate-kentän kunkin arvon mukaisen vuoden:

BirtDateTime.year( row["HireDate"] )

Seuraava esimerkki palauttaa kuluvan päivämäärän mukaisen vuoden:

BirtDateTime.year( (BirtDateTime.today())

(c) Copyright Actuate Corporation 2013