| Table of Contents |
|---|
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.
duration(startDate, endDate)
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.
Parameter(s):
| Name | Type |
|---|---|
| startDate | SimpleDateTime |
| endDate | SimpleDateTime |
Return:
| Type | Description |
|---|---|
| SimpleDuration | The difference between two time values (in seconds). |
Example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
let startDate = new SimpleDateTime('2019-10-25 08:00:00');
let endDate = new SimpleDateTime('2019-10-29 08:00:00');
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
let duration = simple_schedule.duration(startDate, endDate);
ss.info(duration.getValue()); |
load(sysId, timeZone)
Initializes a schedule by the sys_id.
Parameter(s):
| Name | Type |
|---|---|
| sysId | Integer |
| timeZone | String (empty string by default) |
Return:
| Type | Description |
|---|---|
| Void | This method does not return a value |
Example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
let simple_schedule = new SimpleSchedule();
simple_schedule.load('1'); |
getname()
Returns a schedule name.
Return:
| Type | Description |
|---|---|
| String | The schedule name. |
Example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.getName()); |
isValid()
Determines if the specified schedule is valid.
Return:
| Type | Description |
|---|---|
| Boolean | True if the schedule is valid. |
Example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.isValid()); |
isInSchedule(time)
Determines if the given datetime is within the current schedule.
Parameter(s):
| Name | Type |
|---|---|
| time | SimpleDateTime |
Return:
| Type | Description |
|---|---|
| Boolean |
Example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
let time = new SimpleDateTime();
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.isInSchedule(time)); |
setTimeZone(timeZone)
Setting a time zone
Parameter(s):
| Name | Type |
|---|---|
| timeZone | String |
Return:
| Type | Description |
|---|---|
| Void | This method does not return a value |
Example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
let time = new SimpleDateTime();
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
simple_schedule.setTimeZone('US/Central'); |
whenWillExpire(startDate, finalWorkingSeconds)
This method determines the time after working seconds value specified in the finalWorkingSeconds parameter passes.
Parameter(s):
| Name | Type |
|---|---|
| startDate | SimpleDateTime |
| finalWorkingSeconds | Integer |
Return:
| Type | Description |
|---|---|
| String | The time value. |
Example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
let startDate = new SimpleDateTime('2019-10-25 08:00:00');
let finalWorkingSeconds = 12345;
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.whenWillExpire(startDate, finalWorkingSeconds)); |
whenNext(time, timeZone)
Determines how much time (in seconds) is left until next schedule item starts.
Parameter(s):
| Name | Type |
|---|---|
| time | SimpleDateTime |
| timeZone | String |
Return:
| Type | Description |
|---|---|
| Integer | The number in milliseconds. |
Example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
let startDate = new SimpleDateTime('2019-10-25 08:00:00');
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.whenNext(startDate)); |