DateTime - SuperOffice

DateTime is a complex data type representing a timestamp with both date and time elements on ISO format YYYY-MM-DD. The default value is now. Before a Date is initialized, it has no value. This is commonly written as NULL, NUL, or NIL in other programming languages. CRMScript automatically initializes Date objects when declared to the current date. Thus this situation is uncommon.

Constructors

DateTime()

DateTime DateTime()

Default constructor.

DateTime(DateTime)

DateTime DateTime(DateTime value)

Pass a value to copy into a new object.

DateTime(Integer, Integer, Integer, Integer, Integer, Integer)

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

Specify all elements of a DateTime individually. It accepts 6 integer values, representing year, month (1-12), day-of-month (1-31), hour (0-23), minute (0-59), and second (0-59). The constructor automatically calculates the weekday.

DateTime(String)

DateTime DateTime(String value)

Pass a String containing date and time. The constructor will parse the text and create a DateTime object. Formats: 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

Methods

toString()

Converts a DateTime value to its string representation. One of the most frequently used methods, typically when you are going to output something.

String toString()

Returns: CRMScript.Global.String

If you do not want the name of the months and the days, use the toString-function with only one parameter, toString(String format)

Example:

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

toString(String)

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

String toString(String format)

Returns: CRMScript.Global.String

Available codes: ISOW1, ISOW2, ISOWY2, ISOWY4, YY2, YY4, MM1, MM2, DD1, DD2, WEEKDAY, MONTH, WDAY, H24, HH24, H12, HH12, MI2, SS2. For details, see the CRMScript docs.

Example:

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

toString(String, String, String)

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

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

Returns: CRMScript.Global.String

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.Available codes: ISOW1, ISOW2, ISOWY2, ISOWY4, YY2, YY4, MM1, MM2, DD1, DD2, WEEKDAY, MONTH, WDAY, H24, HH24, H12, HH12, MI2, SS2. For details, see the CRMScript docs.

Example:

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

toString(Integer, Integer, Bool)

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

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

Returns: CRMScript.Global.String

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

Example:

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

addDay(Integer)

Adjusts the currently set date with the given number of days.

DateTime addDay(Integer num)

Returns: CRMScript.Global.DateTime Example:

DateTime dt;
dt.addDay(3);

addMonth(Integer)

Adjusts the currently set date with the given number of months.

DateTime addMonth(Integer num)

Returns: CRMScript.Global.DateTime

The day remains unchanged regardless of the number of days in the months added or subtracted. However, if the update would result in February 29th in a year that is not a leap year, CRMScript automatically corrects it to March 1st.

Example:

DateTime dt;
dt.addMonth(3);

addYear(Integer)

Adjusts the currently set date with the given number of years.

DateTime addYear(Integer num)

Returns: CRMScript.Global.DateTime Example:

DateTime dt;
dt.addYear(1);

addHour(Integer)

Adjusts the currently set date with the given number of hours.

DateTime addHour(Integer num)

Returns: CRMScript.Global.DateTime Example:

DateTime dt;
dt.addHour(3);

addMin(Integer)

Adjusts the currently set date with the given number of minutes.

DateTime addMin(Integer num)

Returns: CRMScript.Global.DateTime Example:

DateTime dt;
dt.addMin(30);

addSec(Integer)

Adjusts the currently set date with the given number of seconds.

DateTime addSec(Integer num)

Returns: CRMScript.Global.DateTime Example:

DateTime dt;
dt.addSec(90);

setTime(Time)

Sets the time-part of a DateTime by passing a Time object.

Void setTime(Time theTime)

Returns: CRMScript.Global.DateTime Example:

Time t;
DateTime dt;
dt.setTime(t);

getMDay()

Returns the day of the month as an Integer [1-31].

Integer getMDay()

Returns: CRMScript.Global.Integer Example:

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

getMonth()

Returns the month as an Integer [1-12].

Integer getMonth()

Returns: CRMScript.Global.Integer Example:

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

getWeek()

Returns the number of the week as an Integer [1-53].

Integer getWeek()

Returns: CRMScript.Global.Integer

See http://en.wikipedia.org/wiki/ISO_8601 for detailed info on ISO week numbers.

Example:

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

getWeekDay()

Returns the day of the week as an Integer [0-6].

Integer getWeekDay()

Returns: CRMScript.Global.Integer

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

Example:

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

getYear()

Returns the year as an Integer.

Integer getYear()

Returns: CRMScript.Global.Integer Example:

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

getTime()

Returns the time-portion as a Time object.

Time getTime()

Returns: CRMScript.Global.Time Example:

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

getDate()

Returns the date part of the DateTime

Date getDate()

Returns: CRMScript.Global.Date Example:

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

diff(DateTime)

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.

Integer diff(DateTime value)

Returns: CRMScript.Global.Integer - The number is negative if the input DateTime is the greatest. Example:

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

setUnix(Integer)

Sets the date and time to the number of the seconds since 01.01.1970 00:00:00.

DateTime setUnix(Integer number)

Returns: CRMScript.Global.DateTime

getUnix()

Returns the date and time to the number of the seconds since 01.01.1970 00:00:00.

Integer getUnix()

Returns: CRMScript.Global.Integer

isNull()

Returns true if it has no value and false if it does.

Bool isNull()

Returns: CRMScript.Global.Bool

A NULL/NUL/NIL DateTime is different from zero, in that it is conceptually without a value.

Example:

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

moveToDayStart()

Moves the current DateTime to the start of the day, (00:00 o’clock). Returns a reference to itself.

DateTime moveToDayStart()

Returns: CRMScript.Global.DateTime

moveToHourStart()

Moves the current DateTime to the start of the current hour. Returns a reference to itself.

DateTime moveToHourStart()

Returns: CRMScript.Global.DateTime

moveToMonthStart()

Moves the current DateTime to the first second in the current month. Returns a reference to itself.

DateTime moveToMonthStart()

Returns: CRMScript.Global.DateTime

moveToQuarterStart()

Moves the current DateTime to the start of the current quarter (1. of January, 1. of April, 1. of July, or 1. of October). Returns a reference to itself.

DateTime moveToQuarterStart()

Returns: CRMScript.Global.DateTime

moveToWeekStart()

Moves the current DateTime back to 00:00:00 on monday in the current week. Returns a reference to itself.

DateTime moveToWeekStart()

Returns: CRMScript.Global.DateTime

moveToYearStart()

Moves the current DateTime to the first second in the current year. Returns a reference to itself.

DateTime moveToYearStart()

Returns: CRMScript.Global.DateTime

moveToDayEnd()

Moves the current DateTime to the end of the day (23:59:59). Returns a reference to itself.

DateTime moveToDayEnd()

Returns: CRMScript.Global.DateTime

moveToHourEnd()

Moves the current DateTime to the end of the current hour. Returns a reference to itself.

DateTime moveToHourEnd()

Returns: CRMScript.Global.DateTime

moveToMonthEnd()

Moves the current DateTime to the last second in the current month. Returns a reference to itself.

DateTime moveToMonthEnd()

Returns: CRMScript.Global.DateTime

moveToQuarterEnd()

Moves the current DateTime to the end of current quarter: 31. of Mars, 30. of June, 30 of September or 31. of December. Time is set to 23:59:59. Returns a reference to itself.

DateTime moveToQuarterEnd()

Returns: CRMScript.Global.DateTime

moveToWeekEnd()

Moves the current DateTime forward to 23:59:59 on Sunday of the current week. Returns a reference to itself.

DateTime moveToWeekEnd()

Returns: CRMScript.Global.DateTime

moveToYearEnd()

Moves the current DateTime to the last second in the current year. Returns a reference to itself.

DateTime moveToYearEnd()

Returns: CRMScript.Global.DateTime

​Constructors

​DateTime()

​DateTime(DateTime)

​DateTime(Integer, Integer, Integer, Integer, Integer, Integer)

​DateTime(String)

​Methods

​toString()

​toString(String)

​toString(String, String, String)

​toString(Integer, Integer, Bool)

​Modes:

​addDay(Integer)

​addMonth(Integer)

​addYear(Integer)

​addHour(Integer)

​addMin(Integer)

​addSec(Integer)

​setTime(Time)

​getMDay()

​getMonth()

​getWeek()

​getWeekDay()

​getYear()

​getTime()

​getDate()

​diff(DateTime)

​setUnix(Integer)

​getUnix()

​isNull()

​moveToDayStart()

​moveToHourStart()

​moveToMonthStart()

​moveToQuarterStart()

​moveToWeekStart()

​moveToYearStart()

​moveToDayEnd()

​moveToHourEnd()

​moveToMonthEnd()

​moveToQuarterEnd()

​moveToWeekEnd()

​moveToYearEnd()

Constructors

DateTime()

DateTime(DateTime)

DateTime(Integer, Integer, Integer, Integer, Integer, Integer)

DateTime(String)

Methods

toString()

toString(String)

toString(String, String, String)

toString(Integer, Integer, Bool)

Modes:

addDay(Integer)

addMonth(Integer)

addYear(Integer)

addHour(Integer)

addMin(Integer)

addSec(Integer)

setTime(Time)

getMDay()

getMonth()

getWeek()

getWeekDay()

getYear()

getTime()

getDate()

diff(DateTime)

setUnix(Integer)

getUnix()

isNull()

moveToDayStart()

moveToHourStart()

moveToMonthStart()

moveToQuarterStart()

moveToWeekStart()

moveToYearStart()

moveToDayEnd()

moveToHourEnd()

moveToMonthEnd()

moveToQuarterEnd()

moveToWeekEnd()

moveToYearEnd()