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.

SimpleDateTime(dateTime)


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

NameTypeMandatoryDefault Value
dateTimeStringN''


Example:

Code Block
languagejs
themeEclipse
titleSimpleDateTime
linenumberstrue
const nowDateTime = new SimpleDateTime();
//
const registrationDateTime = new SimpleDateTime(record.registration_datetime);
//
const yearStartDateTime = new SimpleDateTime('2019-01-01 00:00:00');
//
const laborDayStart 

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('2019-05-01'); // 2019-05-01 00: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.

yesterday');
ss.info(yesterdayDatetime.getValue());
// Info: 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('yesterday 06:30');
ss.info(yesterdayWorkdayDayStart.getValue());
// Info: 2022-02-28 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.


Parameter(s):

NameTypeMandatoryDefault Value
daysintegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddDays
linenumberstrue
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)


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 months.


Parameter(s):

NameTypeMandatoryDefault Value
monthsIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddMonths
linenumberstrue
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 secondsThe 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):

NameTypeMandatoryDefault Value
dayssecondsintegerIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddDaysaddSeconds
linenumberstrue
const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addDaysaddSeconds(33600);
ss.info(registrationDateTime.getValue()); 
//Info: 2019-01-0401 0809:12:10
addMonths

addWeeks(

months

weeks)


This method adds a specified is used to change the number of months to weeks in the current SimpleDateTime object according to the local date and time. The negative positive 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 valuesadds weeks to the object, the negative value diminishes the number of weeks.


Parameter(s):

NameTypeMandatoryDefault Value
monthsweeksIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddMonthsaddWeeks
linenumberstrue
const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addMonthsaddWeeks(-1);
ss.info(registrationDateTime.getValue()); 
//Info: 20182019-1201-0108 08:12:10
addSeconds

addYears(

seconds

years)


This method adds a specified is used to change the number of seconds to 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):

NameTypeMandatoryDefault Value
secondsyearsIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddSecondsaddYears
linenumberstrue
const registrationDateTimecontractStartDateTime = new SimpleDateTime('2019-01-01 0800:1200:1000');
registrationDateTimecontractStartDateTime.addSecondsaddYears(36001);
ss.info(registrationDateTimecontractStartDateTime.getValue()); 
//Info: 20192020-01-01 0900:1200:1000
addWeeks

after(

weeks

dateTime)


This method adds a specified number of weeks to the current SimpleDateTime object. The negative value of the parameter will subtract the weeks.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 FALSEThe 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):

NameTypeMandatoryDefault Value
weeksdateTimeIntegerSimpleDateTime objectYN


Return:

TypeDescription
Void
Boolean
This method does not return a value
The method returns TRUE if the current date is later than the date specified by the parameter; otherwise, returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titleaddWeeks
linenumberstrue
after
linenumberstrue
const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const endDateTimeconst registrationDateTime = new SimpleDateTime('2019-01-01 08:1200:1000');
registrationDateTime.addWeeks(1const isStartAfterThanEnd = startDateTime.after(endDateTime);
ss.info(registrationDateTime.getValue()isStartAfterThanEnd); 
// 2019-01-08 08:12:10
addYears(years
Info: false

before(dateTime)


This method adds a specified number of years to the current SimpleDateTime object. The negative value of the parameter will subtract the years.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 falseThe 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):

NameTypeMandatoryDefault Value
yearsdateTimeIntegerSimpleDateTime objectYN


Return:

TypeDescription
VoidThis method does not return a value
BooleanThe method returns TRUE if the current date is earlier than the date specified by the parameter; otherwise, returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titleaddYearsbefore
linenumberstrue
const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const contractStartDateTimeendDateTime = new SimpleDateTime('2019-01-01 0008:00:00');
contractStartDateTime.addYears(1const isStartBeforeEnd = startDateTime.before(endDateTime);
ss.info(contractStartDateTime.getValue()); // 2020-01-01 00:00:00
after
isStartBeforeEnd);
//Info: true

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

The method returns TRUE if the current date is later than the date specified by the parameter; otherwise, returns FALSE
TypeDescriptionDescription
0Dates are equal.
1Object's date is after the date specified in the parameter.
-1Object's date is before the date specified in the parameterBoolean.


Example:

Code Block
languagejs
themeEclipse
titleaftercompareTo
linenumberstrue
const startDateTimebegin = new SimpleDateTime('20182019-0104-01 0708:5815:3500');
const endDateTimeend = new SimpleDateTime('2019-0105-01 08:00:00');
const isStartLaterThanEnd = startDateTime.after(endDateTime);01:00:00');

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

equals(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 a datetime with an existing value to determine whether they are equal or not.


Parameter(s):

NameTypeMandatoryDefault Value
dateTimeSimpleDateTime object.YN


Return:

TypeDescription
BooleanThe This method returns TRUE if the current date is earlier than the date specified by the parameterdate are equal; otherwise, it returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titlebeforeequals
linenumberstruetrue
const firstDateTime = new SimpleDateTime('2018-01-01 08:00:00');
const secondDateTimeconst startDateTime = new SimpleDateTime('2018-01-01 0708:5815:3500');
const endDateTimethirdDateTime = new SimpleDateTime('20192018-01-01 08:00:00');
const isStartBeforeEnd = startDateTime.before(endDateTime

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

compareTo(dateTime)

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

Parameter(s):

NameTypeMandatoryDefault ValuedateTimeSimpleDateTime objectYN

Return:

TypeDescription0Dates are equal1Object's date is after the date specified in the parameter.-1Object's date is before the date specified in the parameter.
Info: true

getDate()


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


Return:

TypeDescription
StringThe date in the default timezone.


Example:

Code Block
languagejs
themeEclipse
titlegetDate
linenumberstrue
const startDateTime

Example:

Code Block
languagejs
themeEclipse
titlecompareTo
linenumberstrue
const firstDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const secondDateTime = new SimpleDateTime('2018-01-01 08:00:00');
const thirdDateTime = new SimpleDateTime('20182019-01-01 08:00:00');


ss.info(thirdDateTime.compareTo(secondDateTime )); // 0
ss.info(firstDateTime.compareTo(secondDateTime)); // 1
ss.info(secondDateTimestartDateTime.compareTogetDate(firstDateTime)); 
//Info: 2019-101-01
equals

getDayOfMonthLocalTime(

dateTime

)


This method compares a datetime with an existing value if they are equal.

Parameter(s):

NameTypeMandatoryDefault ValuedateTimeSimpleDateTime object.YN

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


Return:

TypeDescription
BooleanThis method returns TRUE if the date are equal; otherwise, it returns FALSE
IntegerThe day of the month value.


Example:

Code Block
languagejs
themeEclipse
titleequals
linenumberstrue
getDaysofMonthsLocalTime
linenumberstrue
const holidayDateTimeconst firstDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const secondDateTime = new SimpleDateTime('2018-01-01 08:00:00');
const thirdDateTime = new SimpleDateTime('20182019-01-0107 08:00:00');

ss.info(firstDateTimeholidayDateTime.equalsgetDayOfMonthLocalTime(secondDateTime)); // false
ss.info(thirdDateTime.equals(secondDateTime)); //Info: true7
getDate

getDayOfMonthUTC()


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


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetDategetDaysofMonthsLocalTime
linenumberstrue
const startDateTimeholidayDateTime = new SimpleDateTime('2019-01-0107 08:00:00');
ss.info(startDateTimeholidayDateTime.getDategetDayOfMonthUTC()); 
// 2019-01-01
getDayOfMonthLocalTime
Info: 7

getDayOfWeekLocalTime()


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

Return:

in the current user's time zone.


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetDaysofMonthsLocalTimegetDayOfWeekLocalTime
linenumberstrue
const holidayDateTime = new SimpleDateTime('2019-01-07 08:00:00');
ss.info(holidayDateTime.getDayOfMonthLocalTimegetDayOfWeekLocalTime()); // 7Mon
getDayOfMonthUTC

getDayOfWeekUTC()


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


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetDaysofMonthsLocalTimegetDayOfWeekUTC
linenumberstrue
const holidayDateTime = new SimpleDateTime('2019-01-07 08:00:00');
ss.info(holidayDateTime.getDayOfMonthUTCgetDayOfWeekUTC()); 
//Info: 7Mon
getDayOfWeekLocalTime

getDaysInMonthLocalTime()


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


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetDayOfWeekLocalTimegetDaysInMonthLocalTime
linenumberstrue
const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-0701 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfWeekLocalTimegetDaysInMonthLocalTime()); 
//Info: Mon31
getDayOfWeekUTC

getDaysInMonthUTC()


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


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetDayOfWeekUTCgetDaysInMonthUTC
linenumberstrue
const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-0701 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfWeekUTCgetDaysInMonthUTC()); 
//Info: Mon31
getDaysInMonthLocalTime

getDisplayValue()


This method returns the number of days in the month saved by the SimpleDateTime object, showed in the date and time value in the current user's time zonedisplay format and timezone.


Return:

TypeDescription
Integer
StringThe
number of days
date and time value.


Example:

Code Block
languagejs
themeEclipse
titlegetDaysInMonthLocalTimegetDisplayValue
linenumberstrue
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDaysInMonthLocalTimegetDisplayValue()); // 31
getDaysInMonthUTC
; // current user's timezone is Europe/Moscow
//Info: 2019-01-01 11:00:00 

getErrorMsg()


This method returns the number of days in the month saved by the SimpleDateTime object, showed in the system time zoneerror 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 startDateTime = new SimpleDateTime('2019-01zz-01 08:00:00');
ss.infoerror(startDateTime.getDaysInMonthUTC()); // 31
getDisplayValue
getErrorMsg());
//Error: DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null given

getLocalDate()


This method gets returns the date and time value saved by the SimpleDateTime object in the current user's display format and timezonetime zone.


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetDisplayValuegetLocalDate
linenumberstrue
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDisplayValuegetLocalDate()) ; 
//Info: 2019-01-01 11:00:00
getErrorMsg

getLocalTime()


This method gets the error message if the SimpleDateTime object was incorrectreturns 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
titlegetErrorMsggetLocalTime
linenumberstrue
const startDateTime = new SimpleDateTime('2019-zz-01 08:00:00');
ss.info(startDateTime.getErrorMsg()); // DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null given
getLocalDate
('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 date stored month saved by the SimpleDateTime object , showed in the current 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 startDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
ss.info(startDateTime.getLocalDategetMonthLocalTime()); 
// 2019-01-01
getLocalTime
Info: January

getMonthUTC()


This method returns a the month saved by SimpleDateTime object that shows the time in the user's system 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 startDateTime = new SimpleDateTime('2019-0112-01 08:00:00');
const time = startDateTime.getLocalTime(31 23:45:00');
ss.info( "My local time is " + time.getByFormat('h:m:s'startDateTime.getMonthUTC()); 
// My local time is 02:01:00

getMonthLocalTime()

Info: December

getNumericValue()


This method returns the Unix timestamp, which stores the amount of seconds since January 1, 1970, 00:00:00This method returns 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 startDateTime = new SimpleDateTime('2019-1201-3101 2308:4500:00');
ss.info(startDateTime.getMonthLocalTimegetNumericValue()); 
//Info: January1546329600
getMonthUTC

getTime()


This method returns the month saved by a SimpleDateTime object , showed in the system time zonethat 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 startDateTime = new SimpleDateTime('2019-1201-3101 2308:4500:00');
const time = startDateTime.getTime();
ss.info(startDateTimetime.getMonthUTC(getByFormat('h:i:s')); 
// December

getNumericValue()

Info: 11:01:00

getValue()


This method returns the date and time value in the internal formatThis method gets the Unix timestamp which stores the amount of seconds since January 1, 1970, 00:00:00.


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetNumericValuegetValue
linenumberstrue
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getNumericValuegetValue()); // 1546329600
getTime
2019-01-01 08:00:00

getWeekOfYearLocalTime()


This method returns a the week's number saved by the SimpleDateTime object that shows the piece of time of the SimpleDateTime objectin the current user's time zone.


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetTimegetWeekOfYearLocalTime
linenumberstrue
const startDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
const time = startDateTime.getTime();
ss.info(timestartDateTime.getByFormat('h:m:s'getWeekOfYearLocalTime()); 
// 11:01:00
getValue
Info: 1

getWeekOfYearUTC()


This method gets the date and time value in the internal formatreturns the number of the week saved by the SimpleDateTime object in the system time zone.


Return:

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


Example:

Code Block
languagejs
themeEclipse
titlegetValuegetWeekOfYearUTC
linenumberstrue
const startDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
ss.info(startDateTime.getValuegetWeekOfYearUTC()); 
// 2019-01-01 08:00:00
getWeekOfYearLocalTime
Info: 1

getYearLocalTime()


This method returns the number of the week 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 startDateTimeholidayDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTimeholidayDateTime.getWeekOfYearLocalTimegetYearLocalTime()); 
//Info: 12020
getWeekOfYearUTC

getYearUTC()


This method returns the number of the week 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 startDateTimeholidayDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTimeholidayDateTime.getWeekOfYearUTCgetYearUTC()); 
//Info: 12019
getYearLocalTime

isValid()


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


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 holidayDateTimestartDateTime = new SimpleDateTime('2019-12-31 23:45-01-01 08:00:00');
startDateTime.setValue('2011-aa-01 00:00:00');
ss.info(holidayDateTimestartDateTime.getYearLocalTimeisValid()); 
//Info: 2020false
getYearUTC

setValue(dateTime)


This method

returns the year saved by

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

, showed in the system time zone

.

Return:


Parameter(s):

NameTypeMandatory
Description
Default Value
IntegerFour-digit year value.

Example:

Code Block
languagejs
themeEclipse
titlegetYearUTC
linenumberstrue
const holidayDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(holidayDateTime.getYearUTC()); // 2019

isValid()

This method allows to determine if a specified value is a valid date and time. 
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
Boolean
Void
The method returns TRUE if the value is a valid date and time; otherwise, it returns
This method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleisValidsetValue
linenumberstrue
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
startDateTime.setValue("2011'2020-aa01-01 0012:00:00"');
ss.info(startDateTime.isValidgetValue());  // false
setValue(dateTime

//Info: 2020-01-01 12:00:00

subtract(first, second)


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

Parameter(s):

NameTypeMandatoryDefault ValuedateTimeA string in the local time zone and the internal format of yyyy-MM-dd HH:mm:ss.YNdateTimeA SimpleDateTime object,YNdateTimeA JavaScript Number. It sets the value of the object using the Number value as milliseconds past January 1, 1970, 00:00:00.YN

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

NameTypeMandatoryDefault Value
first

SimpleDateTime Object

YN
secondSimpleDateTime ObjectNNULL


Return:

Type
SimpleDuration object

Return:

TypeDescriptionVoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetValuesubtract #1
linenumberstrue
const startDateTimestartDatetime = new SimpleDateTime('2019-0111-01 08:00:00');
startDateTime.setValue('2020-01-01 12 20:00:00');
ss.info(startDateTime.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):

NameTypeMandatoryDefault Valuefirst

SimpleDateTime Object

YNfirst

SimpleTime Object

YNfirst

Number (milliseconds)

YNsecondSimpleDateTime ObjectNNULLsecondSimpleTime ObjectNNULLsecondNumber (milliseconds)NNULL
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:

TypeSimpleDuration objectExample

:

Code Block
languagejs
themeEclipsetitlesubtract
linenumberstrue
const startDatetime = new SimpleDateTime('2019-11-08 20:00:00');
const endDatetimeconst plannedDateTime = new SimpleDateTime(current.actual_end_datetime); // '2019-11-08 20:00:00'
const actualDateTime('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 = new SimpleDateTime(current.planned_end_datetime); // '2019-11-08 20:06:28'

if (actualDateTime.after(plannedDateTime)) {
  const duraction = actualDateTime.subtract(plannedDateTime, actualDateTime); // 388
  if '2020-08-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(datetime.getValue());
//Info: 2020-08-28 08:00:00(duraction.getDurationSeconds() > 300) { // more than 5 minutes
    ss.eventQueue('notify.change_manager', current, current.assigned_user.getValue('manager'));
  }
}


Table of Contents
absoluteUrltrue