Page History

This server class provides methods are designed to operate work with the SimpleSchedule objects. You can use them, for example, getting to get a schedule name, determining to verify if the current time matches with the working time, and returning return the difference between the two time values.

SimpleSchedule(id,

timeZoneTitle

timezoneTitle)

Instantiates Use this cinstructor to instantiate a new SimpleSchedule object.

Parameter(s):

Name	Type	Mandatory	Default Value
id	String	YN	N
timeZoneTitletimezoneTitle	String	N	'UTC'

Example:

Code Block

language	js
theme	Eclipse
title	scheduleSimpleSchedule
linenumbers	true

const schedule = new SimpleSchedule('157165292607666710', 'UTC');

duration(startDateTime, endDateTime)

This method determines the number of seconds time difference in the schedule between two datetime SimpleDateTime values, based on the schedule time zone or, if not specified, the session the session time zone.

Note
Passed dateTime values The passed SimpleDateTime value should be in the schedule. For checking verification, use the isInSchedule(datetime) method.

Parameter(s):

Name	Type	Mandatory	Default Value
startDateTime	SimpleDateTime object	Y	N
endDateTime	SimpleDateTime	Y	N

Return:

Type	Description
SimpleDuration	The difference between the two time values.

Example:

Code Block

language	js
title	duration

const startDatetime = new SimpleDateTime('20192022-1001-25 08:00:00');
const endDatetime = new SimpleDateTime('20192022-1001-29 08:00:00');
const schedule = new SimpleSchedule('157165292607666710161050499417811121'); // sys_schedule.sys_id
const duration = schedule.duration(startDatetime, endDatetime);
ss.info(duration.getValue());

load(sysId, timeZoneTitle

 // Info: 1970-01-02 08:00:00

getName()

This method

initializes a schedule by the sys_id.

Parameter(s):

NameTypeMandatoryDefault ValuesysIdStringYNtimeZoneTitleString (empty string by default)N''

returns the name of the defined schedule.

Return:

Type	Description

VoidThis method does not return a value

String

The schedule name.

Example:

Code Block

language	js
title	loadgetName

const schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.loadgetName('157165292607666710'));

getname(

 // Info: 8x5 excluding Russian Holidays

isInSchedule(datetime)

This method

returns the name of the defined schedule.

checks whether the current schedule includes the given datetime or they do not match.

Info
Excluded schedule segments will also return 'true' within checking by this method.

Parameter(s):

Name	Type	Mandatory	Default Value
datetime	SimpleDateTime	Y	N

Return:

Type	Description

StringThe schedule name

Boolean

This method returns 'true' if the specified datetime is in schedule; otherwise, it returns 'false'.

Example:

Code Block

language	js
title	getNameisInSchedule

const nowDatetime = new SimpleDateTime();
const schedule = new SimpleSchedule('157165292607666710'); // sys_schedule.sys_id
ss.info(schedule.getNameisInSchedule(nowDatetime)); // Info: 8x5 excluding Russian Holidaysfalse

isValid()

The method checks if the specified schedule is validSimpleSchedule object is valid.

Info

The object is considered as invalid when:

The schedule passed does not exist.
The schedule does not contain schedule elements of the working type. The example type for elements of such schedule is Time Off or Excluded.

In both cases above, the isValid() method returns 'false'.

Return:

Type	Description
Boolean	This method returns TRUE 'true' if the schedule is valid; otherwise, it returns FALSE'false'.

Example:

Code Block

language	js
title	isValid

const schedule = new SimpleSchedule('157165292607666710'); // sys_schedule.sys_id
ss.info(schedule.isValid()); // Info: true

isInSchedule

isWorkingTime(datetime)

This method checks whether the current schedule includes the given datetime or they do not matcha provided date and time is a working time or not.

Parameter(s):

Name	Type	Mandatory	Default Value
datetime	SimpleDateTime	Y	N

Return:

Type	Description
Boolean	This method returns

TRUE if the specified datetime is in schedule

'true' if provided date and time is a working time; otherwise, it returns

FALSE

'false'.

Example:

Code Block

language	js
theme	Eclipse
title	isInSchedule	isWorkingTime
linenumbers	true

const schedule = new SimpleSchedule('157165292607666710'); // sys_schedule.sys_id
const firstDatetimeconst datetime = new SimpleDateTime('2020-12-15 05:59:59');
const schedulesecondDatetime = new SimpleScheduleSimpleDateTime('1571652926076667102020-12-15 06:00:00');
ss.info(schedule.isInScheduleisWorkingTime(datetimefirstDatetime)); // Info: false
ss.info(schedule.isWorkingTime(secondDatetime)); // Info: true

setTimeZone(timeZoneTitle

load(sysId, timezoneTitle)

This method initializes a schedule specified with the sys_id.

Parameter(s):

Name	Type	Mandatory	Default Value
sysId	String	Y	N
timezoneTitle	String (empty string by default)	N	''

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
title	load

const schedule = new SimpleSchedule();
schedule.load('157165292607666710'); // sys_schedule.sys_id

setTimeZone(timezoneTitle)

This method defines which time zone is to be applied to the current schedule.

Parameter(s):

Name	Type	Mandatory	Default Value
timeZoneTitletimezoneTitle	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
title	setTimeZone

const schedule = new SimpleSchedule('157165292607666710'); // sys_schedule.sys_id
schedule.setTimeZone('US/Central');

whenNext(datetime,

timeZoneTitle

timezoneTitle)

This method returns the number of seconds left until the next schedule item startselement starts.

Parameter(s):

Name	Type	Mandatory	Default Value
datetime	SimpleDateTime	Y	N
timeZoneTitletimezoneTitle	String	N	''

Return:

Type	Description
SimpleDuration	The SimpleDuration object.

Example:

Code Block

language	js
theme	Eclipse
title	whenNext
linenumbers	true

const startDatetime = new SimpleDateTime('2019-10-25 08:00:00');
const schedule = new SimpleSchedule('157165292607666710161050499417811121'); // sys_schedule.sys_id
ss.info('Seconds Left: ' + schedule.whenNext(startDatetime).getDurationSeconds()); // Info: Seconds Left: 6052

whenWillExpire(startDateTime, finalWorkingSeconds)

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

Note
Please note that finalWorkingSeconds parameter does not support negative values.

Parameter(s):

Name	Type	Mandatory	Default Value
startDate	SimpleDateTime	Y	N
finalWorkingSeconds	Integer	Y	N

Return:

Type	Description
SimpleDateTime The SimpleDateTime objectobject or 'null'	This method returns the SimpleDateTime object.

Note
If the SimpleSchedule class object is not valid (the isValid() method returns 'false' for this object), then the whenWillExpire() method returns 'null' for it.

Example:

Code Block

language	js
title	whenWillExpire

const startDatetime = new SimpleDateTime('20192022-1001-2523 08:00:00'); // UTC datetime
const finalWorkingSeconds = 600 5 * 8 * 3600; // 10 minutesduration of 5 eight-hour days in seconds
const schedule = new SimpleSchedule('157165292607666710161050499417811121'); // schedule IDsys_schedule.sys_id
ss.info(schedule.whenWillExpire(startDatetime, finalWorkingSeconds).getValue()); // Info: 20192022-1001-2528 0818:1030:00

Table of Contents

absoluteUrl	true
class	fixedPosition

Page tree

Versions Compared

Old Version 60

New Version Current

Key

SimpleSchedule(id,

timezoneTitle)

duration(startDateTime, endDateTime)

getName()

isInSchedule(datetime)

isValid()

isWorkingTime(datetime)

load(sysId, timezoneTitle)

setTimeZone(timezoneTitle)

whenNext(datetime,

timezoneTitle)

whenWillExpire(startDateTime, finalWorkingSeconds)