Versions Compared

Old Version 58

changes.mady.by.user Igor Shakhbazyan

Saved on

compared with

New Version 59

changes.mady.by.user Aleksandr Zhulanov

Saved on

Key

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

This server class provides methods for performing operations on SimpleSchedule objects, such as getting schedule name; determining if the current time value is working time or not or setting time zone for the schedule.

SimpleSchedule(id,

timeZone

timeZoneTitle)

Instantiates a new SimpleSchedule object.


Parameter(s):

NameTypeMandatoryDefault Value
idIntegerStringYN
timezonetimeZoneTitleStringN'UTC'


Example:

Code Block
languagejs
themeEclipse
titleschedule
linenumberstrue
letconst schedule = new SimpleSchedule('157165292607666710', 'UTC');


duration(

startDate

startDateTime,

endDate

endDateTime)

This method determines elapsed time in seconds in the schedule between two date-time values, using schedule time zone or, if not specified, the session time zone.

Note

Passed dateTime values should be in the schedule. For checking use isInSchedule(datetime) method.


Parameter(s):

NameTypeMandatoryDefault Value
startDatestartDateTimeSimpleDateTimeYN
endDateendDateTimeSimpleDateTimeYN


Return:

TypeDescription
SimpleDurationThe difference between the two time values.


Example:

Code Block
languagejs
titleduration
letconst startDatetime = new SimpleDateTime('2019-10-25 08:00:00');
letconst endDatetime = new SimpleDateTime('2019-10-29 08:00:00');
letconst schedule = new SimpleSchedule('157165292607666710');
letconst duration = schedule.duration(startDatetime, endDatetime);
ss.info(duration.getValue());

load(sysId,

timeZone

timeZoneTitle)

This method initializes a schedule by the sys_id.


Parameter(s):

NameTypeMandatoryDefault Value
sysId
Integer
StringYN
timeZone
timeZoneTitleString (empty string by default)N''


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
titleload
letconst schedule = new SimpleSchedule();
schedule.load('157165292607666710');


getname()

This method returns the schedule name.


Return:

TypeDescription
StringThe schedule name.


Example:

Code Block
languagejs
titlegetName
letconst schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.getName()); // Info: 8x5 excluding Russian Holidays


isValid()

This method determines if the specified schedule is valid.


Return:

TypeDescription
BooleanThis method returns TRUE if the schedule is valid; otherwise, it returns FALSE.


Example:

Code Block
languagejs
titleisValid
letconst schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.isValid()); // Info: true

isInSchedule(

time

datetime)

This method determines if the given datetime is within the current schedule.


Parameter(s):

NameTypeMandatoryDefault Value
timedatetimeSimpleDateTimeYN


Return:

TypeDescription
BooleanThis method returns TRUE if the specified datetime is in schedule; otherwise, it returns FALSE.


Example:

Code Block
languagejs
titleisInSchedule
letconst datetime = new SimpleDateTime();
letconst schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.isInSchedule(datetime)); // Info: false

setTimeZone(

timeZone

timeZoneTitle)

This method sets a time zone.


Parameter(s):

NameTypeMandatoryDefault Value
timeZone
timeZoneTitleStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
titlesetTimeZone
letconst schedule = new SimpleSchedule('157165292607666710');
schedule.setTimeZone('US/Central');

whenNext(

time

datetime,

timeZone

timeZoneTitle)

This method determines how much time (in seconds) is left until next schedule item starts.


Parameter(s):

NameTypeMandatoryDefault Value
timedatetimeSimpleDateTimeYN
timeZonetimeZoneTitle

String

N''


Return:

TypeDescription
SimpleDurationThe SimpleDuration object


Example:

Code Block
languagejs
themeEclipse
titlewhenNext
linenumberstrue
letconst startDatetime = new SimpleDateTime('2019-10-25 08:00:00');
letconst schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.whenNext(startDatetime));

whenWillExpire(

startDate

startDateTime, finalWorkingSeconds)

This method determines the time after working seconds value specified in the finalWorkingSeconds parameter passes.


Parameter(s):

NameTypeMandatoryDefault Value
startDate

SimpleDateTime

YN
finalWorkingSecondsIntegerYN


Return:

TypeDescription
SimpleDateTimeThe SimpleDateTime object


Example:


Code Block
languagejs
titlewhenWillExpire
const startDatetime = new SimpleDateTime('2019-10-25 08:00:00'); // UTC datetime
const finalWorkingSeconds = 600; // 10 minutes
letconst schedule = new SimpleSchedule('157165292607666710'); // schedulesschedule ID
ss.info(schedule.whenWillExpire(startDatetime, finalWorkingSeconds).getValue()); // Info: 2019-10-25 08:10:00


Table of Contents
absoluteUrltrue
classfixedPosition