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


Parameter(s):

NameTypeMandatoryDefault Value
secondsIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddSeconds
linenumberstrue
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 weeksThe 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
days
weeks
integer
IntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddDaysaddWeeks
linenumberstrue
const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addDaysaddWeeks(31);
ss.info(registrationDateTime.getValue()); 
//Info: 2019-01-0408 08:12:10
addMonths

addYears(

months

years)


This method adds a specified is used to change the number of months to years in the current SimpleDateTime object . The negative value of the parameter will subtract the months.The method determines according to the 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. The positive value of the parameter adds years to the object, the negative value diminishes the number of years.


Parameter(s):

NameTypeMandatoryDefault Value
months
yearsIntegerYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleaddMonthsaddYears
linenumberstrue
const registrationDateTimecontractStartDateTime = new SimpleDateTime('2019-01-01 0800:1200:1000');
registrationDateTimecontractStartDateTime.addMonthsaddYears(-1);
ss.info(registrationDateTimecontractStartDateTime.getValue()); 
//Info: 20182020-1201-01 0800:1200:1000
addSeconds

after(

seconds

dateTime)


This method adds a specified number of seconds to the current SimpleDateTime objectallows 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
seconds
dateTime
Integer
SimpleDateTime 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
titleaddSecondsafter
linenumberstrue
const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const registrationDateTimeendDateTime = new SimpleDateTime('2019-01-01 08:1200:1000');
registrationDateTime.addSeconds(3600const isStartAfterThanEnd = startDateTime.after(endDateTime);
ss.info(registrationDateTime.getValue(isStartAfterThanEnd)); 
// 2019-01-01 09:12:10
addWeeks(weeks
Info: false

before(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 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 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 earlier than the date specified by the parameter; otherwise, returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titleaddWeeksbefore
linenumberstrue
const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const registrationDateTimeendDateTime = new SimpleDateTime('2019-01-01 08:1200:1000');
registrationDateTime.addWeeks(1;
const isStartBeforeEnd = startDateTime.before(endDateTime);
ss.info(registrationDateTime.getValue()isStartBeforeEnd); 
// 2019-01-08 08:12:10

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.

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 otherThe 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
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
titleaddYearscompareTo
linenumberstrue
const contractStartDateTimebegin = new SimpleDateTime('2019-04-01 08:15:00');
const end = new SimpleDateTime('2019-05-01 0001:00:00');

ss.info(begin.compareTo(end));
contractStartDateTime.addYears(1);   // -1
ss.info(end.compareTo(begin));   // 1
ss.info(contractStartDateTimebegin.getValuecompareTo(begin)); // 2020-01-01 00:00:00
after
0

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 after 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 later than the date specified by the parameterdate are equal; otherwise, it returns FALSE.


Example:

Code Block
languagejs
themeEclipse
titleafterequals
linenumberstrue
const startDateTimefirstDateTime = new SimpleDateTime('2018-01-01 0708:5800:3500');
const endDateTimesecondDateTime = new SimpleDateTime('20192018-01-01 08:0015:00');
const isStartLaterThanEndthirdDateTime = startDateTime.after(endDateTime new SimpleDateTime('2018-01-01 08:00:00');

ss.info(firstDateTime.equals(secondDateTime));
ss.info(thirdDateTime.infoequals(isStartLaterThanEndfirstDateTime)); 
// 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 before the specified; otherwise returns false.

Parameter(s):

NameTypeMandatoryDefault ValuedateTimeSimpleDateTime objectYN
Info: false
//Info: true

getDate()


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


Return:

TypeDescription
Boolean
StringThe
method returns TRUE if the current date is earlier than the date specified by the parameter; otherwise, returns FALSE
date in the default timezone.


Example:

Code Block
languagejs
themeEclipse
titlebefore
linenumberstrue
Eclipse
titlegetDate
linenumberstrue
const startDateTimeconst startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const endDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const isStartBeforeEnd = ss.info(startDateTime.beforegetDate(endDateTime));
ss.info(isStartBeforeEnd); // true

compareTo(dateTime)

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

Parameter(s):

NameTypeMandatoryDefault ValuedateTimeSimpleDateTime objectYN
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
0Dates are equal1Object's date is after the date specified in the parameter.-1Object's date is before the date specified in the parameter
IntegerThe day of the month value.


Example:

Code Block
languagejs
themeEclipse
titlecompareTogetDaysofMonthsLocalTime
linenumberstrue
const firstDateTimeholidayDateTime = new SimpleDateTime('2019-01-0107 08:00:00');
ss.info(holidayDateTime.getDayOfMonthLocalTime());
const secondDateTime = new SimpleDateTime(//Info: 7

getDayOfMonthUTC()


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


Return:

TypeDescription
IntegerThe day of the month value.


Example:

Code Block
languagejs
themeEclipse
titlegetDaysofMonthsLocalTime
linenumberstrue
const holidayDateTime'2018-01-01 08:00:00');
const thirdDateTime = new SimpleDateTime('20182019-01-01 08:00:00');


ss.info(thirdDateTime.compareTo(secondDateTime )); // 007 08:00:00');
ss.info(firstDateTimeholidayDateTime.compareTogetDayOfMonthUTC(secondDateTime)); // 1
ss.info(secondDateTime.compareTo(firstDateTime)); // -1

equals(dateTime)

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

Parameter(s):

NameTypeMandatoryDefault ValuedateTimeSimpleDateTime object.YN
//Info: 7

getDayOfWeekLocalTime()


This method returns the day of the week 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.
StringThe day of week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' 


Example:

Code Block
languagejs
themeEclipse
titleequalsgetDayOfWeekLocalTime
linenumberstrue
const firstDateTimeholidayDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const secondDateTime = new SimpleDateTime('2018-01-01 08:00:00');
const thirdDateTime = new SimpleDateTime('2018-01-0107 08:00:00');

ss.info(firstDateTimeholidayDateTime.equalsgetDayOfWeekLocalTime(secondDateTime)); // false
ss.info(thirdDateTime.equals(secondDateTime)); // true
getDate
Mon

getDayOfWeekUTC()


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


Return:

TypeDescription
StringThe
date in the default timezone.
day of week value.
Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' 


Example:

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

getDaysInMonthLocalTime()


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


Return:

TypeDescription
IntegerThe
day
number of
the month
days value.


Example:

Code Block
languagejs
themeEclipse
titlegetDaysofMonthsLocalTimegetDaysInMonthLocalTime
linenumberstrue
const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-0701 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfMonthLocalTimegetDaysInMonthLocalTime()); 
//Info: 731
getDayOfMonthUTC

getDaysInMonthUTC()


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


Return:

TypeDescription
IntegerThe
day
number of
the month
days value.


Example:

Code Block
languagejs
themeEclipse
titlegetDaysofMonthsLocalTimegetDaysInMonthUTC
linenumberstrue
const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-0701 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfMonthUTCgetDaysInMonthUTC()); 
//Info: 731
getDayOfWeekLocalTime

getDisplayValue()


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


Return:

TypeDescription
StringThe day of week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' 
StringThe date and time value.


Example:

Code Block
languagejs
themeEclipse
titlegetDayOfWeekLocalTimegetDisplayValue
linenumberstrue
const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-07 0801 08:00:00');
ss.info(startDateTime.getDisplayValue()); // current user's timezone is Europe/Moscow
//Info: 2019-01-01 11:00:00');
ss.info(holidayDateTime.getDayOfWeekLocalTime()); // Mon
getDayOfWeekUTC

getErrorMsg()


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

Return:

error message if the SimpleDateTime object was incorrect.


Return:

TypeDescription
StringThe error message.
TypeDescriptionStringThe day of week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' 


Example:

Code Block
languagejs
themeEclipse
titlegetDayOfWeekUTCgetErrorMsg
linenumberstrue
const holidayDateTimestartDateTime = new SimpleDateTime('2019-zz-01-07 08:00:00');
ss.infoerror(holidayDateTimestartDateTime.getDayOfWeekUTCgetErrorMsg()); 
// Mon
getDaysInMonthLocalTime
Error: DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null given

getLocalDate()


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


Return:

TypeDescription
Integer
StringThe
number of days value
date in the user's time zone.


Example:

Code Block
languagejs
themeEclipse
titlegetDaysInMonthLocalTimegetLocalDate
linenumberstrue
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDaysInMonthLocalTimegetLocalDate()); 
// 31
getDaysInMonthUTC
Info: 2019-01-01

getLocalTime()


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


Return:

TypeDescription
Integer
SimpleDateTimeThe
number of days value
time in the user's time zone.


Example:

Code Block
languagejs
themeEclipse
titlegetDaysInMonthUTCgetLocalTime
linenumberstrue
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const time = startDateTime.getLocalTime();
ss.info(startDateTime.getDaysInMonthUTC( "My local time is " + time.getByFormat('h:i:s')); 
// 31
getDisplayValue
Info: My local time is 02:00:00

getMonthLocalTime()


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


Return:

TypeDescription
StringThe
date and time
value of the month.


Example:

Code Block
languagejs
themeEclipse
titlegetDisplayValuegetMonthLocalTime
linenumberstrue
const startDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
ss.info(startDateTime.getDisplayValuegetMonthLocalTime()) ; 
// 2019-01-01 11:00:00
getErrorMsg
Info: January

getMonthUTC()


This method gets the error message if the SimpleDateTime object was incorrectreturns the month saved by SimpleDateTime object in the system time zone.


Return:

TypeDescription
StringThe
error message
value of the month.


Example:

Code Block
languagejs
themeEclipse
titlegetErrorMsggetMonthUTC
linenumberstrue
const startDateTime = new SimpleDateTime('2019-zz12-0131 0823:0045:00');
ss.info(startDateTime.getErrorMsggetMonthUTC()); 
// DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null given
getLocalDate
Info: December

getNumericValue()


This method returns the date stored by the SimpleDateTime object, showed in the user's time zoneUnix timestamp, which stores the amount of seconds since January 1, 1970, 00:00:00.


Return:

TypeDescription
String
IntegerThe
date in the user's time zone
Unix timestamp value.


Example:

Code Block
languagejs
themeEclipse
titlegetLocalDategetNumericValue
linenumberstrue
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getLocalDategetNumericValue()); 
// 2019-01-01
getLocalTime
Info: 1546329600

getTime()


This method returns a SimpleDateTime object that shows the piece of time in the user's time zoneof the SimpleDateTime object.


Return:

TypeDescription
SimpleDateTimeThe
time in the user's time zone
Unix duration stamp.


Example:

Code Block
languagejs
themeEclipse
titlegetLocalTimegetTime
linenumberstrue
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const time = startDateTime.getLocalTimegetTime();
ss.info( "My local time is " + time.getByFormat('h:mi:s')); // My local time is 02
//Info: 11:01:00
getMonthLocalTime

getValue()


This method returns the month saved by SimpleDateTime object, showed in the current user's time zonedate and time value in the internal format.


Return:

TypeDescription
String
null | stringThe date and time value
of
in the
month
internal format.


Example:

Code Block
languagejs
themeEclipse
titlegetMonthLocalTimegetValue
linenumberstrue
const startDateTime = new SimpleDateTime('2019-1201-3101 2308:4500:00');
ss.info(startDateTime.getMonthLocalTimegetValue()); // January
getMonthUTC
2019-01-01 08:00:00

getWeekOfYearLocalTime()


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


Return:

TypeDescription
String
IntegerThe
value
number of the
month
current week.


Example:

Code Block
languagejs
themeEclipse
titlegetMonthUTCgetWeekOfYearLocalTime
linenumberstrue
const startDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTime.getMonthUTCgetWeekOfYearLocalTime()); 
//Info: December1
getNumericValue

getWeekOfYearUTC()


This method gets the timestamp which stores the amount of milliseconds since January 1, 1970, 00:00:00returns the number of the week saved by the SimpleDateTime object in the system time zone.


Return:

TypeDescription
IntegerThe
timestamp value
number of the current week.


Example:

Code Block
languagejs
themeEclipse
titlegetNumericValuegetWeekOfYearUTC
linenumberstrue
const startDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
ss.info(startDateTime.getNumericValuegetWeekOfYearUTC()); 
//Info: 15463296001
getTime

getYearLocalTime()


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


Return:

TypeDescription
SimpleDateTimeThe Unix duration stamp
IntegerFour-digit year value.


Example:

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

getYearUTC()


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


Return:

TypeDescription
null | stringThe date and time value in the internal format
IntegerFour-digit year value.


Example:

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

isValid()


This method returns the number of the week 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
Integer
BooleanThe
number of the current week
method returns TRUE if the value is a valid date and time; otherwise, it returns .


Example:

Code Block
languagejs
themeEclipse
titlegetWeekOfYearLocalTimeisValid
linenumberstrue
const startDateTime = new SimpleDateTime('2019-12-31 23:45-01-01 08:00:00');
startDateTime.setValue('2011-aa-01 00:00:00');
ss.info(startDateTime.getWeekOfYearLocalTimeisValid()); 
//Info: 1false
getWeekOfYearUTC

setValue(dateTime)


This method

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

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:

TypeDescriptionIntegerThe number of the current week.

Example:

Code Block
languagejs
themeEclipse
titlegetWeekOfYearUTC
linenumberstrue
const startDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTime.getWeekOfYearUTC()); // 1

getYearLocalTime()

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

Return:

TypeDescription
IntegerFour-digit year
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlegetYearLocalTimesetValue
linenumberstrue
const holidayDateTimestartDateTime = new SimpleDateTime('2019-12-31 23:45-01-01 08:00:00');
startDateTime.setValue('2020-01-01 12:00:00');
ss.info(holidayDateTimestartDateTime.getYearLocalTimegetValue()); 
//Info: 2020
getYearUTC(
-01-01 12:00:00

subtract(first, second)


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

Return:

TypeDescriptionIntegerFour-digit year value.

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

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. 

Return:

TypeDescriptionBooleanThe method returns TRUE if the value is a valid date and time; otherwise, it returns .


Example:

Code Block
languagejs
themeEclipse
titleisValidsubtract #1
linenumberstrue
const startDateTimestartDatetime = new SimpleDateTime('2019-01-01 08:00:00');
startDateTime.setValue("2011-aa-01 00('2019-11-08 20:00:00"');
ss.info(startDateTime.isValid());  // false

setValue(dateTime)

This method sets 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
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
themeEclipsetitlesetValue
linenumberstrue
const startDateTimestartDatetime = new SimpleDateTime('2019-0111-0108 0820:00:00');
startDateTime.setValueconst endDatetime = new SimpleDateTime('20202019-0111-0108 1220:0006:0028');
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 diffSeconds = endDatetime.getNumericValue() - startDatetime.getNumericValue(); 
ss.info(diffSeconds);
// Info: 388


Code Block
languagejs
themeEclipse
titlesubtract #2
linenumberstrue
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 of the subtract

Return:

TypeSimpleDuration objectExample

:

Code Block
languagejs
themeEclipse
titlesubtract #2
linenumberstrue
const startDateTimedatetime = new SimpleDateTime("2019-01-01 08:00:00");
const periodTime = new SimpleTime();
periodTime.setValue("00:00:20");
startDateTime.subtract(periodTime);
const afterSutractDateTime = startDateTime.getTime(('2020-08-28 09:00:00');
datetime.addSeconds(-3600);
ss.info(afterSutractDateTimedatetime.getByFormat('h:m:s'getValue()); 
// 01:12:40Info: 2020-08-28 08:00:00


Table of Contents
absoluteUrltrueclassfixedPosition