Page History

This server class provides methods for performing operations on SimpleSchedule objects, such as getting schedule name; determining methods are designed to work with the SimpleSchedule objects. You can use them, for example, to get a schedule name, to verify if the current time value is working time or not or setting time zone for the schedule.

duration(startDate, endDate

matches with the working time, and return the difference between the two time values.

SimpleSchedule(id, timezoneTitle)

Use this cinstructor to instantiate a new SimpleSchedule object.

Parameter(s):

Name	Type	Mandatory	Default Value
id	String	N	N
timezoneTitle	String	N	'UTC'

Example:

Code Block

language	js
theme	Eclipse
title	SimpleSchedule
linenumbers	true

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

duration(startDateTime, endDateTime)

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

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

Parameter(s):

Name	Type	Mandatory	Default Value
startDatestartDateTime	SimpleDateTime object	Y	N
endDateendDateTime	SimpleDateTime	Y	N

Return:

Type	Description
SimpleDuration	The difference between the two time values

(in seconds)

.

Example:

Code Block

language	js
title	duration

letconst startDatestartDatetime = new SimpleDateTime('20192022-1001-25 08:00:00');
letconst endDateendDatetime = new SimpleDateTime('20192022-1001-29 08:00:00');
letconst simple_schedule = new SimpleSchedule('1161050499417811121',); 'Europe/Moscow');
let// sys_schedule.sys_id
const duration = simple_schedule.duration(startDatestartDatetime, endDateendDatetime);
ss.info(duration.getValue());

load(sysId, timeZone

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

getName()

This method

initializes a schedule by the sys_id.

Parameter(s):

NameTypeMandatoryDefault ValuesysIdIntegerYNtimeZoneString (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

letconst simple_schedule = new SimpleSchedule('157165292607666710');
simple_ss.info(schedule.loadgetName('1'));

getname(

 // Info: 8x5 excluding Russian Holidays

isInSchedule(datetime)

This method

returns the schedule name.

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	getName	isInSchedule

const nowDatetime = new SimpleDateTime();
const let simple_schedule = new SimpleSchedule('1157165292607666710',); 'Europe/Moscow');// sys_schedule.sys_id
ss.info(simple_schedule.getNameisInSchedule(nowDatetime)); // Info: false

isValid()

This The method determines 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

letconst simple_schedule = new SimpleSchedule('1157165292607666710',); 'Europe/Moscow');// sys_schedule.sys_id
ss.info(simple_schedule.isValid());

isInSchedule(time

 // Info: true

isWorkingTime(datetime)

This method determines if the given datetime is within the current schedulechecks whether a provided date and time is a working time or not.

Parameter(s):

Name	Type	Mandatory	Default Value

time

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.

Example:

'false'.

Code Block

language	js
theme	Eclipse
title	isInSchedule	isWorkingTime
linenumbers	true

const schedulelet time = new SimpleDateTimeSimpleSchedule('157165292607666710');
let simple // sys_schedule.sys_id
const firstDatetime = new SimpleScheduleSimpleDateTime('1', 'Europe/Moscow2020-12-15 05:59:59');
const secondDatetime = new SimpleDateTime('2020-12-15 06:00:00');
ss.info(simple_schedule.isInSchedule(time));

setTimeZone(timeZone

(schedule.isWorkingTime(firstDatetime)); // Info: false
ss.info(schedule.isWorkingTime(secondDatetime)); // Info: true

load(sysId, timezoneTitle)

This method

sets a time zone

initializes a schedule specified with the sys_id.

Parameter(s):

Name	Type	Mandatory	Default Value

timeZone

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	setTimeZoneload

letconst timeschedule = new SimpleDateTimeSimpleSchedule();
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
timezoneTitle	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
title	setTimeZone

const schedule let simple_schedule = new SimpleSchedule('1157165292607666710',); 'Europe/Moscow');
simple_// sys_schedule.sys_id
schedule.setTimeZone('US/Central');

whenNext(

time

datetime,

timeZone

timezoneTitle)

This method determines how much time (in seconds) is returns the number of seconds left until the next schedule item startselement starts.

Parameter(s):

Name	Type	Mandatory	Default Value
timedatetime	SimpleDateTime	Y	N
timeZonetimezoneTitle	String	N	''

Return:

Type	Description
SimpleDuration	The SimpleDuration object.

Example:

Code Block

language	js
theme	Eclipse
title	whenNext
linenumbers	true

letconst startDatestartDatetime = new SimpleDateTime('2019-10-25 08:00:00');
let simple_schedule const schedule = new SimpleSchedule('1161050499417811121',); 'Europe/Moscow');// sys_schedule.sys_id
ss.info(simple_'Seconds Left: ' + schedule.whenNext(startDatestartDatetime).getDurationSeconds()); // Info: Seconds Left: 6052

whenWillExpire(

startDate

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

object 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

letconst startDatestartDatetime = new SimpleDateTime('20192022-1001-2523 08:00:00');
letconst finalWorkingSeconds = 12345;
let simple_ 5 * 8 * 3600; // duration of 5 eight-hour days in seconds
const schedule = new SimpleSchedule('1161050499417811121',); 'Europe/Moscow');// sys_schedule.sys_id
ss.info(simple_schedule.whenWillExpire(startDatestartDatetime, finalWorkingSeconds).getValue()); // Info: 2022-01-28 18:30:00

Table of Contents

absoluteUrl	true
class	fixedPosition

Page tree

Versions Compared

Old Version 48

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)