SimpleDateTime

This class provides methods for performing operations on SimpleDateTime objects, such as instantiating objects, for example.

You can also use this class to perform date-time operations, such as calculations, formatting or converting between date-time formats.

SimpleDateTime(dateTime)

Instantiates a new SimpleDateTime object with the current date and time.

Parameter(s):

Name	Type	Mandatory	Default Value
dateTime	String	N	''

Example:

SimpleDateTime

var simple_date_time = new SimpleDateTime('2019-01-01 08:00:00');

addDays(days)

This method adds a specified number of days to the current SimpleDateTime object. The negative value of the parameter will subtract the days.

The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the days using local date and time values.

Parameter(s):

Name	Type	Mandatory	Default Value
days	integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

addDays

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addDays(-1)
ss.info(simple_date_time.getValue()); // 2018-12-31 08:00:00

addMonths(months)

This method adds a specified number of months to the current SimpleDateTime object. The negative value of the parameter will subtract the months.

The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the months using local date and time values.

Parameter(s):

Name	Type	Mandatory	Default Value
months	Integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

addMonths

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addMonths(-1)
ss.info(simple_date_time.getValue()); // 2018-12-01 08:00:00

addSeconds(seconds)

This method adds a specified number of seconds to the current SimpleDateTime object.

Parameter(s):

Name	Type	Mandatory	Default Value
seconds	Integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

addSeconds

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addSeconds(3600);
ss.info(simple_date_time.getValue()); // 2019-01-01 09:00:00

addWeeks(weeks)

This method adds a specified number of weeks to the current SimpleDateTime object. The negative value of the parameter will subtract the weeks.

The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the weeks using local date and time values.

Parameter(s):

Name	Type	Mandatory	Default Value
weeks	Integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

addWeeks

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addWeeks(-1)
ss.info(simple_date_time.getValue()); // 2018-12-25 08:00:00

addYears(years)

This method adds a specified number of years to the current SimpleDateTime object. The negative value of the parameter will subtract the years.

The method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the years using local date and time values.

Parameter(s):

Name	Type	Mandatory	Default Value
years	Integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

addYears

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addYears(1)
ss.info(simple_date_time.getValue()); // 2020-01-01

after(dateTime)

This method allows to compare the date specified by the ‘dateTime‘ parameter with the current date. The method returns TRUE, if the current date is after the specified; otherwise returns FALSE.

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, returns FALSE.

Example:

after

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var second_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");
let result = first_simple_date_time.after(second_simple_date_time);
ss.info(result) // true

before(dateTime)

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

The method returns TRUE, if the current date is before the specified; otherwise returns false.

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, returns FALSE.

Example:

before

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var second_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");
let result = first_simple_date_time.before(second_simple_date_time);
ss.info(result) // false

compareTo(dateTime)

This method compares two date and time objects to determine whether they are equivalent or not.

Parameter(s):

Name	Type	Mandatory	Default Value
dateTime	SimpleDateTime object	Y	N

Return:

Type	Description
0	Dates are equal
1	Object's date is after the date specified in the parameter.
-1	Object's date is before the date specified in the parameter.

Example:

compareTo

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var second_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");
var third_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");

ss.info( first_simple_date_time.compareTo(second_simple_date_time) ); // 1
ss.info( second_simple_date_time.compareTo(first_simple_date_time) ); // -1
ss.info( third_simple_date_time.compareTo(second_simple_date_time ) ); // 0

equals(dateTime)

This method compares a datetime with an existing value if 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 date are equal; otherwise, it returns FALSE.

Example:

equals

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var second_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");
var third_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");

ss.info( first_simple_date_time.equals(second_simple_date_time) ); // 0
ss.info( third_simple_date_time.equals(second_simple_date_time ) ); // 1

getDate()

This method returns the date stored by the SimpleDateTime object, showed in the system time zone.

Return:

Type	Description
String	The date in the default timezone.

Example:

getDate

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDate() ); // 2019-01-01

getDaysInMonthLocalTime()

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

Return:

Type	Description
Integer	The number of days value.

Example:

getDaysInMonthLocalTime

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDaysInMonthLocalTime() ); // 31

getDayOfMonthLocalTime()

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

Return:

Type	Description
Integer	The day of the month value.

Example:

getDaysofMonthsLocalTime

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDayOfMonthLocalTime() ); // 1

getDayOfMonthUTC()

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

Return:

Type	Description
Integer	The day of the month value.

Example:

getDaysofMonthsLocalTime

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDayOfMonthUTC() );

getDayOfWeekLocalTime()

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

Return:

Type	Description
String	The day of week value.

Example:

getDayOfWeekLocalTime

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDayOfWeekLocalTime() ); // Tue

getDayOfWeekUTC()

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

Return:

Type	Description
String	The day of week value.

Example:

getDayOfWeekUTC

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDayOfWeekUTC() );

getDaysInMonthUTC()

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

Return:

Type	Description
Integer	The number of days value.

Example:

getDaysInMonthUTC

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDaysInMonthUTC() );

getDisplayValue()

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

Return:

Type	Description
String	The date and time value.

Example:

getDisplayValue

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getDisplayValue() ) ; //uses current user session time zone

getErrorMsg()

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

Return:

Type	Description
String	The error message.

Example:

getErrorMsg

var first_simple_date_time = new SimpleDateTime("2019-zz-01 08:00:00");
ss.info( first_simple_date_time.getErrorMsg() ) ;  //The parsed date or time was invalid!

getLocalDate()

This method returns the date stored by the SimpleDateTime object, showed in the user's time zone.

Return:

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

Example:

getLocalDate

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getLocalDate() )

getLocalTime()

This method returns a SimpleDateTime object that shows the time in the user's time zone.

Return:

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

Example:

getLocalTime

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var time = first_simple_date_time.getLocalTime();
ss.info( "My local time is " + time.getByFormat('h:m:s') ) ;

getMonthLocalTime()

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

Return:

Type	Description
String	The value of the month.

Example:

getMonthLocalTime

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getMonthLocalTime() ); // January

getMonthUTC()

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

Return:

Type	Description
String	The value of the month.

Example:

getMonthUTC

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getMonthUTC() );

getNumericValue()

This method gets the timestamp which stores the amount of milliseconds since January 1, 1970, 00:00:00.

Return:

Type	Description
Integer	The timestamp value.

Example:

getNumericValue

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getNumericValue() ) ; // 1546318800

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:

getTime

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
var time = first_simple_date_time.getTime();
ss.info( time.getByFormat('h:m:s') );

getValue()

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

Return:

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

Example:

getValue

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getValue() ); //2019-01-01 08:00:00

getWeekOfYearLocalTime()

This method returns the number of the week saved by the SimpleDateTime object, showed in the user's time-zone.

Return:

Type	Description
Integer	The number of the current week.

Example:

getWeekOfYearLocalTime

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getWeekOfYearLocalTime() ); // 1

getWeekOfYearUTC()

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

Return:

Type	Description
Integer	The number of the current week.

Example:

getWeekOfYearUTC

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getWeekOfYearUTC() );

getYearLocalTime()

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

Return:

Type	Description
Integer	Four-digit year value.

Example:

getYearLocalTime

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getYearLocalTime()

getYearUTC()

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

Return:

Type	Description
Integer	Four-digit year value.

Example:

getYearUTC

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
ss.info( first_simple_date_time.getYearUTC() );

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:

isValid

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
first_simple_date_time.setDisplayValue("2011-aa-01 00:00:00");
ss.info( first_simple_date_time.isValid() ) ;  // false

setValue(dateTime)

This method sets the date and time of the SimpleDateTime object.

Parameter(s):

Name	Type	Mandatory	Default Value
dateTime	A string in the local time zone 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:

setValue

var first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
first_simple_date_time.setValue("2020-01-01 12:00:00");
ss.info( first_simple_date_time.getValue() );  // 2020-01-01 12:00:00

subtract(first, second)

This method gets the duration between to SimpleDateTime values. Also, it can subtract the amount of time from the current SimpleDateTime object.

Parameter(s):

Name	Type	Mandatory	Default Value
first	SimpleDateTime Object	Y	N
first	SimpleTime Object	Y	N
first	Number (milliseconds)	Y	N
second	SimpleDateTime Object	N	NULL
second	SimpleTime Object	N	NULL
second	Number (milliseconds)	N	NULL

Return:

Type
SimpleDuration object

Example:

subtract

var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");

var simple_time = new SimpleTime();
simple_time.setValue("00:00:20");

simple_date_time.subtract(simple_time);

var second_simple_time  = simple_date_time.getTime();
ss.info( second_simple_time.getByFormat('h:m:s') ); // 2019-01-01 07:59:40

Page tree