Page History

Use this class to conduct operations on SimpleDateTime objects, for example, instantiating objects, and to calculate, change formats of the date-time or convert between the formats.

SimpleDateTime(dateTime)

Instantiates a new SimpleDateTime object with the current or transferred date/time. The date and time value should be specified in the UTC timezone.

Parameter(s):

Name	Type	Mandatory	Default Value
dateTime	String	N	''

Example:

Code Block

language	js
theme	Eclipse
title	SimpleDateTime
linenumbers	true

const nowDateTime = new SimpleDateTime();
//
const registrationDateTime = new SimpleDateTime(record.registration_datetime);
//
const yearStartDateTime = new SimpleDateTime('2019-01-01 00:00:00');

addDays(days)

Use this method to change the number of days in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds days to the object, the negative value diminishes the number of days.

Parameter(s):

Name	Type	Mandatory	Default Value
days	integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	addDays
linenumbers	true

const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addDays(3);
ss.info(registrationDateTime.getValue());
//Info: 2019-01-04 08:12:10

addMonths(months)

Use this method to change the number of months in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds months to the object, the negative value diminishes the number of months.

Parameter(s):

Name	Type	Mandatory	Default Value
months	Integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	addMonths
linenumbers	true

const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addMonths(-1);
ss.info(registrationDateTime.getValue());
//Info: 2018-12-01 08:12:10

addSeconds(seconds)

This method is used to change the number of seconds in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds seconds to the object, the negative value diminishes the number of seconds.

Parameter(s):

Name	Type	Mandatory	Default Value
seconds	Integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	addSeconds
linenumbers	true

const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addSeconds(3600);
ss.info(registrationDateTime.getValue());
//Info: 2019-01-01 09:12:10

addWeeks(weeks)

This method is used to change the number of weeks in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds weeks to the object, the negative value diminishes the number of weeks.

Parameter(s):

Name	Type	Mandatory	Default Value
weeks	Integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	addWeeks
linenumbers	true

const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addWeeks(1);
ss.info(registrationDateTime.getValue());
//Info: 2019-01-08 08:12:10

addYears(years)

This method is used to change the number of years in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds years to the object, the negative value diminishes the number of years.

Parameter(s):

Name	Type	Mandatory	Default Value
years	Integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	addYears
linenumbers	true

const contractStartDateTime = new SimpleDateTime('2019-01-01 00:00:00');
contractStartDateTime.addYears(1);
ss.info(contractStartDateTime.getValue());
//Info: 2020-01-01 00:00:00

after(dateTime)

This method allows comparing the date specified by the ‘dateTime‘ parameter with the current date.

Parameter(s):

Name	Type	Mandatory	Default Value
dateTime	SimpleDateTime object	Y	N

Return:

Type	Description
Boolean	The method returns 'true' if the current date is later than the date specified by the parameter; otherwise, it returns 'false'.

Example:

Code Block

language	js
theme	Eclipse
title	after
linenumbers	true

const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const endDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const isStartAfterThanEnd = startDateTime.after(endDateTime);
ss.info(isStartAfterThanEnd);
//Info: false

before(dateTime)

This method allows comparing the date specified by the ‘dateTime‘ parameter with the current date.

Parameter(s):

Name	Type	Mandatory	Default Value
dateTime	SimpleDateTime object	Y	N

Return:

Type	Description
Boolean	The method returns 'true' if the current date is earlier than the date specified by the parameter; otherwise, it returns 'false'.

Example:

Code Block

language	js
theme	Eclipse
title	before
linenumbers	true

const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const endDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const isStartBeforeEnd = startDateTime.before(endDateTime);
ss.info(isStartBeforeEnd);
//Info: true

compareTo(dateTime)

This method compares two date and time objects to determine whether they are equal and, if not, the method defines which goes after or before the other.

Parameter(s):

Name	Type	Mandatory	Default Value
dateTime	SimpleDateTime object	Y	N

Return:

Type	Description
0	The dates are equal.
1	The object's date is after the date specified in the parameter.
-1	The object's date is before the date specified in the parameter.

Example:

Code Block

language	js
theme	Eclipse
title	compareTo
linenumbers	true

const begin = new SimpleDateTime('2019-04-01 08:15:00');
const end = new SimpleDateTime('2019-05-01 01:00:00');

ss.info(begin.compareTo(end));   // -1
ss.info(end.compareTo(begin));   // 1
ss.info(begin.compareTo(begin)); // 0

equals(dateTime)

This method compares a datetime with an existing value to determine whether they are equal.

Parameter(s):

Name	Type	Mandatory	Default Value
dateTime	SimpleDateTime object.	Y	N

Return:

Type	Description
Boolean	This method returns 'true' if the dates are equal; otherwise, it returns 'false'.

Example:

Code Block

language	js
theme	Eclipse
title	equals
linenumbers	true

const firstDateTime = new SimpleDateTime('2018-01-01 08:00:00');
const secondDateTime = new SimpleDateTime('2018-01-01 08:15:00');
const thirdDateTime = new SimpleDateTime('2018-01-01 08:00:00');

ss.info(firstDateTime.equals(secondDateTime));
ss.info(thirdDateTime.equals(firstDateTime));
//Info: false
//Info: true

getDate()

This method returns the date saved by the SimpleDateTime object in the system time zone.

Return:

Type	Description
String	The date in the default timezone.

Example:

Code Block

language	js
theme	Eclipse
title	getDate
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDate());
//Info: 2019-01-01

getDayOfMonthLocalTime()

This method returns the day of the month saved by the SimpleDateTime object in the current user's time zone.

Return:

Type	Description
Integer	The day of the month value.

Example:

Code Block

language	js
theme	Eclipse
title	getDaysofMonthsLocalTime
linenumbers	true

const holidayDateTime = new SimpleDateTime('2019-01-07 08:00:00');
ss.info(holidayDateTime.getDayOfMonthLocalTime());
//Info: 7

getDayOfMonthUTC()

This method returns the day of the month saved by the SimpleDateTime object in the UTC time zone.

Return:

Type	Description
Integer	The day of the month value.

Example:

Code Block

language	js
theme	Eclipse
title	getDaysofMonthsLocalTime
linenumbers	true

const holidayDateTime = new SimpleDateTime('2019-01-07 08:00:00');
ss.info(holidayDateTime.getDayOfMonthUTC());
//Info: 7

getDayOfWeekLocalTime()

This method returns the day of the week saved by the SimpleDateTime object in the current user's time zone.

Return:

Type	Description
String	The day of week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'

Example:

Code Block

language	js
theme	Eclipse
title	getDayOfWeekLocalTime
linenumbers	true

const holidayDateTime = new SimpleDateTime('2019-01-07 08:00:00');
ss.info(holidayDateTime.getDayOfWeekLocalTime()); // Mon

getDayOfWeekUTC()

This method returns the day of the week saved by the SimpleDateTime object in the system time zone.

Return:

Type	Description
String	The day of the week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'

Example:

Code Block

language	js
theme	Eclipse
title	getDayOfWeekUTC
linenumbers	true

const holidayDateTime = new SimpleDateTime('2019-01-07 08:00:00');
ss.info(holidayDateTime.getDayOfWeekUTC());
//Info: Mon

getDaysInMonthLocalTime()

This method returns the number of days in the month saved by the SimpleDateTime object in the current user's time zone.

Return:

Type	Description
Integer	The number of days value.

Example:

Code Block

language	js
theme	Eclipse
title	getDaysInMonthLocalTime
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDaysInMonthLocalTime());
//Info: 31

getDaysInMonthUTC()

This method returns the number of days in the month saved by the SimpleDateTime object in the system time zone.

Return:

Type	Description
Integer	The number of days value.

Example:

Code Block

language	js
theme	Eclipse
title	getDaysInMonthUTC
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDaysInMonthUTC());
//Info: 31

getDisplayValue()

This method returns the date and time value in the current user's display format and timezone.

Return:

Type	Description
String	The date and time value.

Example:

Code Block

language	js
theme	Eclipse
title	getDisplayValue
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDisplayValue()); // current user's timezone is Europe/Moscow
//Info: 2019-01-01 11:00:00

getErrorMsg()

This method returns the error message if the SimpleDateTime object was incorrect.

Return:

Type	Description
String	The error message.

Example:

Code Block

language	js
theme	Eclipse
title	getErrorMsg
linenumbers	true

const startDateTime = new SimpleDateTime('2019-zz-01 08:00:00');
ss.error(startDateTime.getErrorMsg());
//Error: DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null given

getLocalDate()

This method returns the date saved by the SimpleDateTime object in the current user's time zone.

Return:

Type	Description
String	The date in the user's time zone.

Example:

Code Block

language	js
theme	Eclipse
title	getLocalDate
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getLocalDate());
//Info: 2019-01-01

getLocalTime()

This method returns the time saved in a SimpleDateTime object in the current user's time zone .

Return:

Type	Description
SimpleDateTime	The time in the user's time zone.

Example:

Code Block

language	js
theme	Eclipse
title	getLocalTime
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const time = startDateTime.getLocalTime();
ss.info( "My local time is " + time.getByFormat('h:i:s'));
//Info: My local time is 02:00:00

getMonthLocalTime()

This method returns the month saved by SimpleDateTime object in the current user's time zone.

Return:

Type	Description
String	The value of the month.

Example:

Code Block

language	js
theme	Eclipse
title	getMonthLocalTime
linenumbers	true

const startDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTime.getMonthLocalTime());
//Info: January

getMonthUTC()

This method returns the month saved by SimpleDateTime object in the system time zone.

Return:

Type	Description
String	The value of the month.

Example:

Code Block

language	js
theme	Eclipse
title	getMonthUTC
linenumbers	true

const startDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTime.getMonthUTC());
//Info: December

getNumericValue()

This method returns the Unix timestamp, which stores the amount of seconds since January 1, 1970, 00:00:00.

Return:

Type	Description
Integer	The Unix timestamp value.

Example:

Code Block

language	js
theme	Eclipse
title	getNumericValue
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getNumericValue());
//Info: 1546329600

getTime()

This method returns a SimpleDateTime object that shows the piece of time of the SimpleDateTime object.

Return:

Type	Description
SimpleDateTime	The Unix duration stamp.

Example:

Code Block

language	js
theme	Eclipse
title	getTime
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const time = startDateTime.getTime();
ss.info(time.getByFormat('h:i:s'));
//Info: 11:01:00

getValue()

This method returns the date and time value in the internal format.

Return:

Type	Description
null \| string	The date and time value in the internal format.

Example:

Code Block

language	js
theme	Eclipse
title	getValue
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getValue()); // 2019-01-01 08:00:00

getWeekOfYearLocalTime()

This method returns the week's number saved by the SimpleDateTime object in the current user's time zone.

Return:

Type	Description
Integer	The number of the current week.

Example:

Code Block

language	js
theme	Eclipse
title	getWeekOfYearLocalTime
linenumbers	true

const startDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTime.getWeekOfYearLocalTime());
//Info: 1

getWeekOfYearUTC()

This method returns the number of the week saved by the SimpleDateTime object in the system time zone.

Return:

Type	Description
Integer	The number of the current week.

Example:

Code Block

language	js
theme	Eclipse
title	getWeekOfYearUTC
linenumbers	true

const startDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTime.getWeekOfYearUTC());
//Info: 1

getYearLocalTime()

This method returns the year saved by the SimpleDateTime object in the current user's time zone.

Return:

Type	Description
Integer	Four-digit year value.

Example:

Code Block

language	js
theme	Eclipse
title	getYearLocalTime
linenumbers	true

const holidayDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(holidayDateTime.getYearLocalTime());
//Info: 2020

getYearUTC()

This method returns the year saved by the SimpleDateTime object in the system time zone.

Return:

Type	Description
Integer	Four-digit year value.

Example:

Code Block

language	js
theme	Eclipse
title	getYearUTC
linenumbers	true

const holidayDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(holidayDateTime.getYearUTC()); 
//Info: 2019

isValid()

This method allows to determine if a specified value is a valid date and time.

Return:

Type	Description
Boolean	The method returns 'true' if the value is a valid date and time; otherwise, it returns 'false'.

Example:

Code Block

language	js
theme	Eclipse
title	isValid
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
startDateTime.setValue('2011-aa-01 00:00:00');
ss.info(startDateTime.isValid());
//Info: false

setValue(dateTime)

Use this method to define the date and time value within the SimpleDateTime object.

Parameter(s):

Name	Type	Mandatory	Default Value
dateTime	A string in the UTC timezone and the internal format of YYYY-MM-DD hh:mm:ss.	Y	N
dateTime	A SimpleDateTime object.	Y	N
dateTime	A JavaScript Number. It sets the value of the object using the Number value as milliseconds past January 1, 1970, 00:00:00.	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setValue
linenumbers	true

const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
startDateTime.setValue('2020-01-01 12:00:00');
ss.info(startDateTime.getValue());
//Info: 2020-01-01 12:00:00

subtract(first, second)

This method returns the amount of time between two SimpleDateTime values. Also, it can subtract the amount of time from the current SimpleDateTime object.

Note
Displaying of the final value using the getDisplayValue() method returns it the value considering the current user' timezone, unlike the . The getValue() method . It returns data only in the UTC timezone.

Parameter(s):

Name	Type	Mandatory	Default Value
first	SimpleDateTime Object	Y	N
second	SimpleDateTime Object	N	NULL

Return:

Type
SimpleDuration object

Example:

Code Block

language	js
theme	Eclipse
title	subtract #1
linenumbers	true

const startDatetime = new SimpleDateTime('2019-11-08 20:00:00');
const endDatetime = new SimpleDateTime('2019-11-08 20:06:28');
const diffDuration = new SimpleDateTime().subtract(startDatetime, endDatetime); 
ss.info(diffDuration.getDurationSeconds());
// Info: 388

Same example without using the subtract:

Code Block

language	js
theme	Eclipse
linenumbers	true

const startDatetime = new SimpleDateTime('2019-11-08 20:00:00');
const endDatetime = new SimpleDateTime('2019-11-08 20:06:28');
const diffSeconds = endDatetime.getNumericValue() - startDatetime.getNumericValue(); 
ss.info(diffSeconds);
// Info: 388

Code Block

language	js
theme	Eclipse
title	subtract #2
linenumbers	true

const datetime = new SimpleDateTime('2020-08-28 09:00:00');
datetime.subtract(3600);
ss.info(datetime.getValue());
//Info: 2020-08-28 08:00:00

Same example without using the subtract:

Code Block

language	js
theme	Eclipse
title	subtract #2
linenumbers	true

const datetime = new SimpleDateTime('2020-08-28 09:00:00');
datetime.addSeconds(-3600);
ss.info(datetime.getValue());
//Info: 2020-08-28 08:00:00

Table of Contents

absoluteUrl	true

Page tree

Versions Compared

Old Version 4

New Version 5

Key

SimpleDateTime(dateTime)

addDays(days)

addMonths(months)

addSeconds(seconds)

addWeeks(weeks)

addYears(years)

after(dateTime)

before(dateTime)

compareTo(dateTime)

equals(dateTime)

getDate()

getDayOfMonthLocalTime()

getDayOfMonthUTC()

getDayOfWeekLocalTime()

getDayOfWeekUTC()

getDaysInMonthLocalTime()

getDaysInMonthUTC()

getDisplayValue()

getErrorMsg()

getLocalDate()

getLocalTime()

getMonthLocalTime()

getMonthUTC()

getNumericValue()

getTime()

getValue()

getWeekOfYearLocalTime()

getWeekOfYearUTC()

getYearLocalTime()

getYearUTC()

isValid()

setValue(dateTime)

subtract(first, second)