DateTime data type - SuperOffice

DateTime is a complex data type representing a timestamp with both date and time elements on ISO format. The default value is now. Format: YYYY-MM-DD

DateTime dt;
print(dt.toString());

This will print today’s date and the current time.

You can create arrays of any data type to store more than one value at the same time like this: String[] s1;. For a given array, all items must be of the same type. Read more about looping and accessing array items in the fundamentals section.

Constructors

DateTime DateTime(DateTime dt)

Pass a DateTime object to copy into a new object.

DateTime dt;
DateTime past = DateTime(dt);
printLine(past.toString());

DateTime DateTime(Integer year, Integer month, Integer mday, Integer hour, Integer min, Integer sec)

Specify all elements of a DateTime individually. The constructor automatically calculates the weekday.

DateTime schoolEnds = DateTime(2020,06,22,11,0,0);
printLine(schoolEnds.toString());

DateTime DateTime(String p0)

Pass a String containing date and time on the format of one of the listed formats. The constructor will parse the text and create a DateTime object.

YYYY-MM-DD HH:MM:SS
YYYY-MM-DD HH:MM - automatically sets sec = 0
YYYYMMDDHHMMSS - mysql.timestamp
YYYY-MM-DD - automatically sets the time to 23:59:59 or 0:0:0 depending on endOfDay setting
an empty string or “0” - sets stamp to Jan 1. 1970 00:00:00 and isNull()
YYYY-MM-DD HH:MM:SS:XXX

DateTime graduation = DateTime("2020-06-22 11:00");
printLine(graduation.toString());

Timestamps as strings

String toString()

toString() is one of the most frequently used methods, typically when you are going to output something. It returns a string representation of a DateTime object using standard formatting.

DateTime dt;
printLine(dt.toString());

This is the equivalent of:

Time t;
Date d;
printLine(d.toString() + " " + t.toString());

String toString(String format)

A variant of toString() that takes a string with formatting codes. You can also include white-space and punctuation marks.

DateTime dt;
printLine(dt.toString("HH12:MI2 AMPM"));

This will print the current time as hh:mm in 12-hour mode and indicating whether it is am or pm.

String toString(String format, String months, String weekDays)

A variant of toString() that takes a string with formatting codes plus comma-separated lists of month and weekday names in your preferred language.

DateTime dt;
String days="søndag,mandag,tirsdag,onsdag,torsdag,fredag,lørdag";
printLine(dt.toString("WDAY uke ISOW1","",days));

If you don’t include codes MONTH, WDAY, or both - use toString(String format) instead. If you include only 1 of them, send an empty string for the one you don’t use.

String toString(Integer mode, Integer language, Bool 24HourMode)

A variant of toString() that takes codes for mode and language as Integers and a boolean indicator for 12- or 24-hour clock.

true: use time in 24-hour mode
false: use time in 12-hour mode

DateTime dt;
printLine(dt.toString(6,1,true));

This will print today’s date and the current time formatted similar to toString() without arguments, but with the month as a 3-letter abbreviation. Mode: [0-16], see end of this section Try the following snippet to view output of all modes.

DateTime dt;
Integer i = 0;
while (i < 17){
  printLine(dt.toString(i,1,true));
  i++;
}

Languages:

Code	Language
0	Norwegian
1	English
2	German
3	Swedish
4	Danish
5	Dutch

Setting and updating date and time

Date and time values are set relative to when the DateTime object was created.

A positive increment indicates sometime in the future.
A negative value indicates sometime in the past.

The amount must be provided as an Integer input parameter.

DateTime addDay(Integer num)

addDay() will adjust the currently set date with the given number of days. The parameter granularity is days.

DateTime dt;
dt.addDay(3);
printLine("Three days from now: "  + dt.toString());

DateTime addMonth(Integer num)

addMonth() will adjust the currently set date with the given number of months. The parameter granularity is months.

DateTime dt;
dt.addMonth(3);
printLine("Three months from now: "  + dt.toString());

DateTime addYear(Integer num)

addYear() will adjust the currently set date with the given number of years. The parameter granularity is years.

DateTime dt;
dt.addYear(1);
printLine("A year from now: "  + dt.toString());

DateTime addHour(Integer num)

addHour() will adjust the currently set time with the given number of hours. The parameter granularity is hours.

DateTime dt;
dt.addHour(3);
printLine("Three hours from now: "  + dt.toString());

DateTime addMin(Integer num)

addMin() will adjust the currently set time with the given number of minutes. The parameter granularity is minutes.

DateTime dt;
dt.addMin(30);
printLine("Half an hour from now: "  + dt.toString());

DateTime addSec(Integer num)

addSec() will adjust the currently set time with the given number of seconds. The parameter granularity is days.

DateTime dt;
dt.addSec(90);
printLine("90 seconds from now: "  + dt.toString());

Void setTime(Time theTime)

setTime() sets the time-part of a DateTime by passing a Time object.

Time t;
t.setHour(13);
t.setMin(0);
t.setSec(0);
DateTime dt;
dt.setTime(t);
printLine(dt.toString());

This will output the current date and time fixed to 13 o’clock.

Retrieving date and time details

Integer getMDay()

getMDay() returns the day of the month as an Integer [1-31].

DateTime dt;
print(dt.getMDay().toString());

Integer getMonth()

getMonth() returns the month as an Integer [1-12].

DateTime dt;
print(dt.getMonth().toString());

Integer getWeek()

getWeek() returns the number of the week as an Integer [1-53].

DateTime dt;
print(dt.getWeek().toString());

Integer getWeekDay()

getWeekDay() returns the day of the week as an Integer [0-6].

DateTime dt;
print(dt.getWeekDay().toString());

The 1st day of the week is Monday and has index 0!

Integer getYear()

getYear() returns the year as an Integer.

DateTime dt;
print(dt.getYear().toString());

Time getTime()

getTime() returns the time-portion as a Time object.

DateTime dt;
Time t = dt.getTime();
print(t.toString());

Date getDate()

getDate() returns the date part of the DateTime

DateTime dt;
Date d = dt.getDate();
print(d.toString());

Comparing timestamps

Integer diff(DateTime otherDateTime)

diff() returns the difference in the number of seconds between 2 timestamps. The method subtracts the passed timestamp from the DateTime object you invoke diff() on.

DateTime dt1;
DateTime dt2;
dt2.addHour(1);
print(dt1.diff(dt2).toString());

This will print -3600 because dt2 is 1 hour (60x60 seconds) ahead of dt1. Understanding return values:

String	Relation	Parameter	dt1.diff(dt2) returns
DateTime dt1	less than	DateTime dt2	negative Integer
DateTime dt1	equal	DateTime dt2	zero
DateTime dt1	greater than	DateTime dt2	positive Integer

dt1 < dt2 means that dt1 comes before dt2 in chronological time.

UNIX time

For when you need to convert between SuperOffice and integrated systems running on UNIX time.

DateTime setUnix(Integer number)

setUnix() sets the date and time to the number of the seconds since 01.01.1970 00:00:00.

Integer getUnix()

getUnix() returns the number of seconds since 01.01.1970 00:00:00.

No value

Before a DateTime is initialized, it has no value. This is commonly written as NULL, NUL, or NIL in other programming languages. CRMScript automatically initializes DateTime objects when declared to the current timestamp. Thus this situation is uncommon. However, it is a good habit to always test that you have a value before using it.

Bool isNull()

isNull() will return true if it has no value and false if it does.

DateTime dt;
print(dt.isNull().toString());

Formatting options

Week numbers and year

Code	Includes	Number of digits
ISOW1	week number	1 or 2
ISOW2	week number	2
ISOWY2	year according to ISO week	2
ISOWY4	year according to ISO week	4
YY2	year	2
YY4	year	4

ISOWY2/4 will calculate and return the year corresponding to the ISO week number of the given date. This year may be different from the “date” year.

Month and day

Code	Includes	Number of digits
MM1	month	1 or 2
MM2	month	2
DD1	day	1 or 2
DD2	day	2

Code	Includes
WEEKDAY	weekday, with Monday as 1
MONTH	name of month
WDAY	name of weekday

WEEKDAY differs from the getWeekDay() method of the Date object where Monday has index 0! WDAY and MONTH do start at index 0, thus construct your lists so that the indexes line up.

Time

Code	Includes	Number of digits
H24	hours, 24-hour mode	1 or 2
HH24	hours, 24-hour mode	2
H12	hours, 12-hour mode	1 or 2
HH12	hours, 12-hour mode	2
MI2	minutes	2
SS2	seconds	2

AMPM returns either am or pm.

Modes

Code	Name	Format	Example
0	modeNewDate	YYYY-MM-DD	2020-05-29
1	modeNew2Min	YYYY-MM-DD hh:mm	2020-05-29 13:37
2	modeNew2Sec	YYYY-MM-DD hh:mm:ss	2020-05-29 13:37:42
3	modeTextDate	DD. MMM YYYY (no)	May 29. 2020
		MMM DD. YYYY (en)	29. Mai 2020
4	modeText2Min	DD. MMM YYYY 11:23	May 29. 2020 13:37
5	modeText2Sec	DD. MMM YYYY 11:23:15	May 29. 2020 13:37:42
6	modeText2MinLong	DD. MMM YYYY hh:mm (no)	29. Mai 2020 13:37
		MMM. DD. YYYY hh:mm (en)	May 29. 2020 13:37
7	modeShort2Min	MM/DD/YYYY hh:mm (no)	29/05/2020 13:37
		DD/MM/YYYY hh:mm (en)	05/29/2020 13:37
8	modeNumeric	YYYYMMDDhhmmss	20200529133742
9	modeTime2Min	hh:mm	13:37
10	modeTime2Sec	hh:mm:ss	13:37:42
11	modeCompressed	YYYYMMDDhhmmss	20200529133942
12	modeRFC1123	ddd, DD MMM YY hh:mm:ss GMT	Fri, 29 May 20 13:37:42 GMT
13	modeSoap	YYYY-DD-MMThh:mm:ss	2020-05-29T13:37:42
14	modeRFC822	ddd, DD MMM YYYY hh:mm:ss +hhmm	Fri, 29 May 2020 13:37:42 +0200
15	modeDateFirst	MM.DD.YYYY hh.mm	29.05.2020 13:37
16	modeSlash2Min	MM/DD/YYYY hh.mm	29/05/2020 13:37

Remarks:

12 is HTTP-date
13 is SOAP standard formatting

toString() will not adjust to GMT, so you will have to do it yourself!

​Constructors

​DateTime DateTime(DateTime dt)

​DateTime DateTime(Integer year, Integer month, Integer mday, Integer hour, Integer min, Integer sec)

​DateTime DateTime(String p0)

​Timestamps as strings

​String toString()

​String toString(String format)

​String toString(String format, String months, String weekDays)

​String toString(Integer mode, Integer language, Bool 24HourMode)

​Setting and updating date and time

​DateTime addDay(Integer num)

​DateTime addMonth(Integer num)

​DateTime addYear(Integer num)

​DateTime addHour(Integer num)

​DateTime addMin(Integer num)

​DateTime addSec(Integer num)

​Void setTime(Time theTime)

​Retrieving date and time details

​Integer getMDay()

​Integer getMonth()

​Integer getWeek()

​Integer getWeekDay()

​Integer getYear()

​Time getTime()

​Date getDate()

​Comparing timestamps

​Integer diff(DateTime otherDateTime)

​UNIX time

​DateTime setUnix(Integer number)

​Integer getUnix()

​No value

​Bool isNull()

​Formatting options

​Week numbers and year

​Month and day

​Time

​Modes

Constructors

DateTime DateTime(DateTime dt)

DateTime DateTime(Integer year, Integer month, Integer mday, Integer hour, Integer min, Integer sec)

DateTime DateTime(String p0)

Timestamps as strings

String toString()

String toString(String format)

String toString(String format, String months, String weekDays)

String toString(Integer mode, Integer language, Bool 24HourMode)

Setting and updating date and time

DateTime addDay(Integer num)

DateTime addMonth(Integer num)

DateTime addYear(Integer num)

DateTime addHour(Integer num)

DateTime addMin(Integer num)

DateTime addSec(Integer num)

Void setTime(Time theTime)

Retrieving date and time details

Integer getMDay()

Integer getMonth()

Integer getWeek()

Integer getWeekDay()

Integer getYear()

Time getTime()

Date getDate()

Comparing timestamps

Integer diff(DateTime otherDateTime)

UNIX time

DateTime setUnix(Integer number)

Integer getUnix()

No value

Bool isNull()

Formatting options

Week numbers and year

Month and day

Time

Modes