Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This class provides methods for performing operations on SimpleDateTime objects, such as instantiating objects, for exampleThe class is used to conduct operations on SimpleDateTime objects, for example, instantiating objects.

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

addDaysLocalTime

SimpleDateTime(

days

dateTime)

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 GlideDateTime object, then adds or subtracts the days using local date and time values

Use this constructor to instantiate a new SimpleDateTime object with the current or transferred date/time. Specify the date and time value in the UTC timezone.

Parameter(s):

daysInteger
NameTypeMandatoryDefault Value
Return:
dateTime
Type
String
Description
N
VoidThis method does not return a value.
''


Example:

Code Block
languagejs
themeEclipse
titleSimpleDateTime
linenumberstrueaddDaysLocalTime
var simple_date_timeconst nowDateTime = new SimpleDateTime();
//
const registrationDateTime = new SimpleDateTime(record.registration_datetime);
//
const yearStartDateTime = new SimpleDateTime("'2019-01-01 0800:00:00");
simple_date_time.addDaysLocalTime(-1)');

You can also use the values in relative format for the SimpleDateTime constructor. All formats are available in the Relative Formats article.

Code Block
languagejs
themeEclipse
titleSimpleDateTime
linenumberstrue
const yesterdayDatetime = new SimpleDateTime('yesterday');
ss.info(simple_date_timeyesterdayDatetime.getValue()); 
// 2018-12-31

addDaysUTC(days)

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

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

Parameter(s):

NameTypedaysinteger

Return:

TypeDescriptionVoidThis method does not return a value.

Example:

Code Block
languagejs
titleaddDaysUTC
var simple_date_timeInfo: 2022-02-28 00:00:00  

const tomorrowDatetime = new SimpleDateTime('tomorrow');
ss.info(tomorrowDatetime.getValue());
// Info: 2022-03-02 00:00:00

const yesterdayWorkdayDayStart = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addDaysUTC(-1)
'yesterday 06:30');
ss.info(simple_date_timeyesterdayWorkdayDayStart.getValue()); 
// Info: 20182022-1202-3128 08:00:00

addMonthsLocalTime(months)

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 GlideDateTime object, then adds or subtracts the months using local date and time values.

Parameter(s):

NameTypemonthsInteger

Return:

TypeDescriptionVoidThis method does not return a value.
06:30:00

const fistDayOfNextMonthStart = new SimpleDateTime('first day of next month 00:00');
ss.info(fistDayOfNextMonthStart.getValue());
// Info: 2022-04-01 00:00:00

const rangeStartDatetime = new SimpleDateTime(`first day of ${monthName}`);
ss.info(rangeStartDatetime .getValue());
// Info: 2022-02-01 00:00:00

const YEAR = 2022;
const MONTH = 2;
const monthDatetime = new SimpleDateTime(`${YEAR}-${String(MONTH).padStart(2, '0')}-02 00:00:00`);
const monthName = monthDatetime.getMonthUTC();
ss.info(monthName);
// Info: February


addDays(days)


This method is used 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

Example:

Code Block
languagejs
titleaddMonthsLocalTime
var simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
simple_date_time.addMonthsLocalTime(1)
ss.info(simple_date_time.getValue()); // 2019-02-01

addMonthsUTC(months)

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

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


Parameter(s):

Integer
NameTypemonthsMandatoryDefault Value
daysintegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddDays
linenumbersaddMonthsUTCTimetrue
var simple_date_timeconst registrationDateTime = new SimpleDateTime("'2019-01-01 08:0012:00"10');
simple_date_time.addMonthsUTC(-1)registrationDateTime.addDays(3);
ss.info(simple_date_timeregistrationDateTime.getValue()); 
//Info: 20182019-1201-0104 08:0012:0010

addSeconds(seconds)

addMonths(months)


This method is used 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 monthsAdd a specified number of seconds to the current SimpleDateTime object.


Parameter(s):

NameTypeMandatoryDefault Value
monthssecondsIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddSecondsaddMonths
linenumberstrue
const registrationDateTimevar simple_date_time = new SimpleDateTime("'2019-01-01 08:0012:00"10');
simple_date_time.addSeconds(3600registrationDateTime.addMonths(-1);
ss.info(simple_date_timeregistrationDateTime.getValue()); 
//Info: 20192018-0112-01 0908:0012:0010
addWeeksLocalTime

addSeconds(

weeks

seconds)


Adds a specified This method is used to change the number of weeks to seconds in the current SimpleDateTime object according to the local date and time. The negative positive value of the parameter will subtract the weeks.The method determines local date and time equivalent to the value saved by the GlideDateTime object, then adds or subtracts the weeks using local date and time valuesadds seconds to the object, the negative value diminishes the number of seconds.


Parameter(s):

integer
NameTypeweeksMandatoryDefault Value
secondsIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddSeconds
linenumbersaddWeeksLocalTimetrue
var simple_date_timeconst registrationDateTime = new SimpleDateTime("'2019-01-01 08:0012:00"10');
simple_date_time.addWeeksLocalTime(2)registrationDateTime.addSeconds(3600);
ss.info(simple_date_timeregistrationDateTime.getValue()); 
//Info: 2019-01-15
addWeeksUTC
01 09:12:10

addWeeks(weeks)


Adds a specified This method is used to change the number of weeks to in the current SimpleDateTime object according to the local date and time. The negative positive value of the parameter will subtract the weeks.The method determines UTC date and time equivalent to the value saved by the GlideDateTime object, then adds or subtracts the weeks using UTC date and time valuesadds weeks to the object, the negative value diminishes the number of weeks.


Parameter(s):

NameTypeTypeMandatoryDefault Value
weeksIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddWeeksUTCaddWeeks
linenumberstrue
const registrationDateTimevar simple_date_time = new SimpleDateTime("'2019-01-01 08:0012:00"10');
simple_date_time.addWeeksUTC(-registrationDateTime.addWeeks(1);
ss.info(simple_date_timeregistrationDateTime.getValue()); 
//Info: 20182019-1201-2508 08:0012:0010
addYearsLocalTime

addYears(years)


Adds a specified This method is used to change the number of years to in the current SimpleDateTime object according to the local date and time. The negative positive value of the parameter will subtract the years.The method determines local date and time equivalent to the value saved by the GlideDateTime object, then adds or subtracts the years using local date and time valuesadds years to the object, the negative value diminishes the number of years.


Parameter(s):

NameTypeMandatoryDefault Value
yearsYearsIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddYearsLocalTimeaddYears
linenumberstrue
const contractStartDateTimevar simple_date_time = new SimpleDateTime("'2019-01-01 0800:00:00"');
simple_date_time.addYearsLocalTimecontractStartDateTime.addYears(1);
ss.info(simple_date_timecontractStartDateTime.getValue());
//Info: 2020-01-01 00:00:00

after(dateTime)

; // 2020-01-01

addYearsUTC(years)

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

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

Parameter(s):

NameTypeYearsInteger

Return:

TypeDescriptionVoidThis method does not return a value.


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):

NameTypeMandatoryDefault Value
dateTimeSimpleDateTime objectYN


Return:

TypeDescription
BooleanThe method returns TRUE if the current date is later than the date specified by the parameter; otherwise, returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titleafter
linenumberstrue
const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const endDateTime

Example:

Code Block
languagejs
titleaddYearsLocalTime
var simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00"');
simple_date_time.addYearsLocalTime(1)const isStartAfterThanEnd = startDateTime.after(endDateTime);
ss.info(simple_date_time.getValue()isStartAfterThanEnd); 
// 2020-01-01
after
Info: false

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 after before the specified; otherwise returns false.


Parameter(s):

NameTypeMandatoryDefault Value
dateTimeSimpleDateTime objectYN


Return:

TypeDescription
Boolean
Returns true
The method returns TRUE if the current date is
later
earlier than the date specified by the parameter; otherwise, returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titlebefore
linenumbersaftertrue
var first_simple_date_timeconst startDateTime = new SimpleDateTime("2019'2018-01-01 0807:0058:00"35');
var second_simple_date_timeconst endDateTime = new SimpleDateTime("2018'2019-01-01 08:00:00"');
letconst resultisStartBeforeEnd = first_simple_date_time.after(second_simple_date_timestartDateTime.before(endDateTime);
ss.info(resultisStartBeforeEnd) ;
//Info: true
before

compareTo(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 falsecompares 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):

NameTypeMandatoryDefault Value
dateTimeSimpleDateTime objectYN


Return:

TypeDescription
BooleanReturns true if the current date is earlier than the date specified by
0Dates are equal.
1Object's date is after the date specified in the parameter.
-1Object's date is before the date specified in the parameter.


Example:

Code Block
languagejs
themeEclipse
titlecompareTo
linenumbersbeforetrue
const beginvar first_simple_date_time = new SimpleDateTime("'2019-0104-01 08:0015:00"');
var second_simple_date_timeconst end = new SimpleDateTime("2018'2019-0105-01 0801:00:00"');
let result = first_simple_date_time.before(second_simple_date_time);

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

equals(dateTime)


Compares two date and time objects This method compares a datetime with an existing value to determine whether they are equivalent equal or not.


Parameter(s):

NameTypeMandatoryDefault Value
dateTimeSimpleDateTime object.

Return:

YN


Return:

TypeDescription
BooleanThis method returns TRUE if the date are equal; otherwise, it returns FALSE
TypeDescription0Dates are equal1Object's date is after the date specified in the parameter.-1Object's date is before the date specified in the parameter
.


Example:

Code Block
languagejs
themeEclipse
titleequals
linenumberscompareTotrue
var first_simple_date_timeconst firstDateTime = new SimpleDateTime("2019'2018-01-01 08:00:00"');
var second_simple_date_timeconst secondDateTime = new SimpleDateTime("'2018-01-01 08:0015:00"');
var third_simple_date_timeconst thirdDateTime = 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) ); // -1firstDateTime.equals(secondDateTime));
ss.info( third_simple_date_time.compareTo(second_simple_date_time ) ); // 0

equals(dateTime)

Compares a datetime with an existing value if they are equal.

Parameter(s):

NameType
thirdDateTime.equals(firstDateTime));
//Info: false
//Info: true

getDate()


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

dateTimeSimpleDateTime object

.


Return:

TypeDescription
BooleanReturns true if the date are equal; otherwise returns false
StringThe date in the default timezone.


Example:

Code Block
languagejs
themeEclipse
titleequalsgetDate
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00"');
ss.info(startDateTime.getDate());
var second_simple_date_time = new SimpleDateTime("2018-01-01 08:00:00");
var third_simple_date_time//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:

TypeDescription
IntegerThe day of the month value.


Example:

Code Block
languagejs
themeEclipse
titlegetDaysofMonthsLocalTime
linenumberstrue
const holidayDateTime = new SimpleDateTime("2018'2019-01-0107 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()

holidayDateTime.getDayOfMonthLocalTime());
//Info: 7

getDayOfMonthUTC()


This method returns the day of the month saved by the SimpleDateTime object in the UTC Returns the date stored by the GlideDateTime object, showed in the system time zone.


Return:

TypeDescription
String
IntegerThe
date in the default timezone
day of the month value.


Example:

Code Block
languagejs
themeEclipse
titlegetDategetDaysofMonthsLocalTime
linenumberstrue
const holidayDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-0107 08:00:00"');
ss.info( first_simple_date_time.getDateholidayDateTime.getDayOfMonthUTC() ); 
// 2019-01-01
getDaysInMonthLocalTime
Info: 7

getDayOfWeekLocalTime()


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


Return:

TypeDescription
Integer
StringThe
number
day of
days value.
week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' 


Example:

Code Block
languagejs
themeEclipse
titlegetDaysInMonthLocalTimegetDayOfWeekLocalTime
linenumberstrue
const holidayDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-0107 08:00:00"');
ss.info( first_simple_date_time.getDaysInMonthLocalTimeholidayDateTime.getDayOfWeekLocalTime() ); // 31Mon
getDayOfMonthLocalTime

getDayOfWeekUTC()


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


Return:

TypeDescription
Integer
StringThe day of
the month value.
week value.
Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' 


Example:

Code Block
languagejs
themeEclipse
titlegetDayOfWeekUTC
linenumberstruegetDaysofMonthsLocalTime
var first_simple_date_timeconst holidayDateTime = new SimpleDateTime("'2019-01-0107 08:00:00"');
ss.info( first_simple_date_time.getDayOfMonthLocalTimeholidayDateTime.getDayOfWeekUTC() ); 
//Info: 1Mon
getDayOfMonthUTC

getDaysInMonthLocalTime()


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


Return:

TypeDescription
IntegerThe
day
number of
the month
days value.


Example:

Code Block
languagejs
titlegetDaysofMonthsLocalTime
languagejs
themeEclipse
titlegetDaysInMonthLocalTime
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00"');
ss.info( first_simple_date_time.getDayOfMonthUTCstartDateTime.getDaysInMonthLocalTime() );
getDayOfWeekLocalTime

//Info: 31

getDaysInMonthUTC()


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


Return:

TypeDescription
String
IntegerThe
day
number of
week
days value.


Example:

Code Block
languagejs
titlegetDayOfWeekLocalTime
js
themeEclipse
titlegetDaysInMonthUTC
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00"');
ss.info( first_simple_date_time.getDayOfWeekLocalTimestartDateTime.getDaysInMonthUTC() ); 
//Info: Tue31
getDayOfWeekUTC

getDisplayValue()


Returns the day of the week saved by the SimpleDateTime object, showed in the system time zoneThis method returns the date and time value in the current user's display format and timezone.


Return:

TypeDescription
StringThe
day of week
date and time value.


Example:

Code Block
languagejs
themeEclipse
titlegetDayOfWeekUTCgetDisplayValue
linenumberstrue
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDisplayValue()); // current user's timezone is Europe/Moscow
//Info: var first_simple_date_time = new SimpleDateTime("2019-01-01 0811:00:00");
ss.info( first_simple_date_time.getDayOfWeekUTC() );
getDaysInMonthUTC

getErrorMsg()


Returns the number of days in the month saved by the SimpleDateTime object, showed in the system time zoneThis method returns the error message if the SimpleDateTime object was incorrect.


Return:

TypeDescription
Integer
StringThe
number of days value
error message.


Example:

Code Block
languagejs
themeEclipse
titlegetDaysInMonthUTCgetErrorMsg
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01zz-01 08:00:00"');
ss.info( first_simple_date_time.getDaysInMonthUTC() );

getDisplayValue()

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 Gets the date and time value in the current user's display format and timezonetime zone.


Return:

TypeDescription
Null |
StringThe date in the user's time zone.


Example:

Code Block
languagejs
themeEclipse
titlegetDisplayValuegetLocalDate
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00"');
ss.info( first_simple_date_time.getDisplayValuestartDateTime.getLocalDate() ) ; 
//uses current user session time zone
getErrorMsg
Info: 2019-01-01

getLocalTime()


Gets the error message if the SimpleDateTime object was incorrectThis method returns the time saved in a SimpleDateTime object in the current user's time zone .


Return:

TypeDescription
String
SimpleDateTimeThe
error message
time in the user's time zone.


Example:

Code Block
languagejs
themeEclipse
titlegetLocalTime
linenumbersgetErrorMsgtrue
var first_simple_date_timeconst startDateTime = new SimpleDateTime("'2019-zz-01 08:00:00"01-01 08:00:00');
const time = startDateTime.getLocalTime();
ss.info( first_simple_date_time.getErrorMsg() ) ;  //The parsed date or time was invalid!

getLocalDate()

"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 Returns the date stored by the GlideDateTime object, showed in the user's time zone.


Return:

TypeDescription
StringThe
date in the user's time zone
value of the month.


Example:

Code Block
languagejs
themeEclipse
titlegetLocalDategetMonthLocalTime
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-0112-0131 0823:0045:00"');
ss.info( first_simple_date_time.getLocalDate() )

getLocalTime()

startDateTime.getMonthLocalTime());
//Info: January

getMonthUTC()


This method returns the month saved by SimpleDateTime object in the system Returns a SimpleDateTime object that shows the time in the user's time zone.


Return:

TypeDescription
SimpleDateTime
StringThe
time in the user's time zone
value of the month.


Example:

Code Block
languagejs
themeEclipse
titlegetLocalTimegetMonthUTC
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-0112-0131 08:00:00");
var time = first_simple_date_time.getLocalTime(23:45:00');
ss.info( "My local time is " + time.getByFormat('h:m:s') ) ;

getMonthLocalTime()

startDateTime.getMonthUTC());
//Info: December

getNumericValue()


This method returns the Unix timestamp, which stores the amount of seconds since January 1, 1970, 00:00:00Returns the month saved by SimpleDateTime object, showed in the current user's time zone.


Return:

TypeDescription
String
IntegerThe Unix timestamp value
of the month
.


Example:

Code Block
languagejs
themeEclipse
titlegetMonthLocalTimegetNumericValue
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00"');
ss.info( first_simple_date_time.getMonthLocalTimestartDateTime.getNumericValue() ); 
//Info: January1546329600
getMonthUTC

getTime()


Returns the month saved by SimpleDateTime object, showed in the system time zoneThis method returns a SimpleDateTime object that shows the piece of time of the SimpleDateTime object.


Return:

TypeDescription
String
SimpleDateTimeThe
value of the month
Unix duration stamp.


Example:

Code Block
languagejs
themeEclipse
titlegetMonthUTCgetTime
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00"');
const time = startDateTime.getTime();
ss.info( first_simple_date_time.getMonthUTC() );

getNumericValue()

getByFormat('h:i:s'));
//Info: 11:01:00

getValue()


This method returns the date and time value in the internal formatGets the timestamp which stores the amount of milliseconds since January 1, 1970, 00:00:00.


Return:

TypeDescription
Integer
null | stringThe
timestamp
date and time value in the internal format.


Example:

Code Block
languagejs
themeEclipse
titlegetNumericValuegetValue
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00"');
ss.info( first_simple_date_time.getNumericValuestartDateTime.getValue() ) ; // 1546318800

getTime()

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 zoneReturns a SimpleDateTime object that shows the piece of time of the SimpleDateTime object.


Return:

TypeDescription
SimpleDateTime
IntegerThe
Unix duration stamp
number of the current week.


Example:

Code Block
languagejs
themeEclipse
titlegetWeekOfYearLocalTime
linenumbersgetTimetrue
var first_simple_date_timeconst startDateTime = new SimpleDateTime("'2019-0112-0131 0823:0045:00");
var time = first_simple_date_time.getTime(');
ss.info( timestartDateTime.getByFormat('h:m:s') );

getValue()

getWeekOfYearLocalTime());
//Info: 1

getWeekOfYearUTC()


This method returns the number of the week saved by the SimpleDateTime object in the system time zoneGets the date and time value in the internal format.


Return:

TypeDescription
null | string
IntegerThe
date and time value in the internal format
number of the current week.


Example:

Code Block
languagejs
themeEclipse
titlegetWeekOfYearUTC
linenumbersgetValuetrue
var first_simple_date_timeconst startDateTime = new SimpleDateTime("'2019-0112-0131 0823:0045:00"');
ss.info( first_simple_date_time.getValuestartDateTime.getWeekOfYearUTC() ); 
//2019-01-01 08:00:00
getWeekOfYearLocalTime
Info: 1

getYearLocalTime()


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


Return:

TypeDescription
Integer
The number of the current week
Four-digit year value.


Example:

Code Block
languagejs
themeEclipse
titlegetWeekOfYearLocalTimegetYearLocalTime
linenumberstrue
const holidayDateTimevar first_simple_date_time = new SimpleDateTime("'2019-0112-0131 0823:0045:00"');
ss.info( first_simple_date_time.getWeekOfYearLocalTimeholidayDateTime.getYearLocalTime() ); 
//Info: 12020
getWeekOfYearUTC

getYearUTC()


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


Return:

TypeDescription
Integer
The number of the current week
Four-digit year value.


Example:

Code Block
languagejs
themeEclipse
titlegetWeekOfYearUTCgetYearUTC
linenumberstrue
const holidayDateTimevar first_simple_date_time = new SimpleDateTime("'2019-0112-0131 0823:0045:00"');
ss.info( first_simple_date_time.getWeekOfYearUTCholidayDateTime.getYearUTC() );

getYearLocalTime()

 
//Info: 2019

isValid()


This method allows to determine if a specified value is a valid date and timeReturns the year saved by the SimpleDateTime object, showed in the user's time zone.


Return:

TypeDescription
IntegerFour-digit year value
BooleanThe method returns TRUE if the value is a valid date and time; otherwise, it returns .


Example:

Code Block
languagejs
themeEclipse
titlegetYearLocalTimeisValid
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00');
startDateTime.setValue('2011-aa-01 00:00:00"');
ss.info( first_simple_date_time.getYearLocalTime()

getYearLocalUTC()

Returns the year saved by the SimpleDateTime object, showed in the system zone.

Return:

TypeDescriptionIntegerFour-digit year value.

Example:

Code Block
languagejs
titlegetYearLocalTime
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. 
startDateTime.isValid());
//Info: false

setValue(dateTime)


This method is intended to define the date and time value within the SimpleDateTime object.


Parameter(s):

NameTypeMandatoryDefault Value
dateTimeA string in the UTC timezone and the internal format of YYYY-MM-DD hh:mm:ss.YN
dateTimeA SimpleDateTime object.YN
dateTimeA JavaScript Number. It sets the value of the object using the Number value as milliseconds past January 1, 1970, 00:00:00.YN


Return:

TypeDescription
BooleanReturns true if value is a valid date and time; otherwise, returns false
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleisValidsetValue
linenumberstrue
const startDateTimevar first_simple_date_time = new SimpleDateTime("'2019-01-01 08:00:00"');
first_simple_date_time.setDisplayValue("2011-aastartDateTime.setValue('2020-01-01 0012:00:00"');
ss.info(startDateTime.getValue());
//Info: first_simple_date_time.isValid() ) ;  // false

setDisplayValue(dateTime, format)

Sets the dateTime value using the current user's display format and time zone. 
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 considering the current user' timezone, unlike the getValue() method. It returns data only in UTC timezone.


Parameter(s):

NameType
dateTimeStringformat
MandatoryDefault Value
first

SimpleDateTime Object

YN
secondSimpleDateTime ObjectNNULL
String


Return:

Type
DescriptionVoidThis method does not return a value.
SimpleDuration object


Example:

Code Block
languagejs
themeEclipse
titlesetDisplayValuesubtract #1
linenumberstrue
const startDatetimevar first_simple_date_time = new SimpleDateTime("'2019-0111-01 08:00:00");
first_simple_date_time.setDisplayValue("2020-01-01 12 20:00:00"');
ss.info( first_simple_date_time.getValue() );

setValue(dateTime)

Sets the date and time of the SimpleDateTime object

Parameter(s):

NameTypedateTimeA string in the UTC time zone and the internal format of yyyy-MM-dd HH:mm:ss.dateTimeA SimpleDateTime objectdateTimeA JavaScript Number. Sets the value of the object using the Number value as milliseconds past January 1, 1970, 00: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 of the subtract

Return:

TypeDescriptionVoidThis method does not return a value.Example

:

Code Block
languagejs
titlesetValue
themeEclipse
linenumberstrue
const startDatetimevar first_simple_date_time = new SimpleDateTime("2019-01-01 08:00:00");
first_simple_date_time.setValue("2020-01-01 12SimpleDateTime('2019-11-08 20: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 an amount of time from the current SimpleDateTime object.

Parameter(s):

NameTypefirst

SimpleDateTime Object

first

SimpleTime Object

first

Number (milliseconds)

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


Code Block
languagejs
themeEclipse
titlesubtract #2
linenumberstrue
const datetime

Return:

TypeSimpleDuration object

Example:

Code Block
languagejs
titlesubtract
var simple_date_time = new SimpleDateTime("2019'2020-0108-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(28 09:00:00');
datetime.subtract(3600);
ss.info(datetime.getValue());
//Info: 2020-08-28 08:00:00

Same example without using of the subtract:

Code Block
languagejs
themeEclipse
titlesubtract #2
linenumberstrue
const datetime = new SimpleDateTime('2020-08-28 09:00:00');
datetime.addSeconds(-3600);
ss.info( second_simple_time.getByFormat('h:m:s') ); // 2019-01-01 07:59:40datetime.getValue());
//Info: 2020-08-28 08:00:00


Table of Contents
absoluteUrltrue
Table of Contents
classfixedPosition