You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 59 Next »
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, timeZoneTitle)
Instantiates a new SimpleSchedule object.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| id | String | Y | N |
| timeZoneTitle | String | N | 'UTC' |
Example:
const schedule = new SimpleSchedule('157165292607666710', 'UTC');
duration(startDateTime, 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.
Passed dateTime values should be in the schedule. For checking use isInSchedule(datetime) method.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| startDateTime | SimpleDateTime | Y | N |
| endDateTime | SimpleDateTime | Y | N |
Return:
| Type | Description |
|---|---|
| SimpleDuration | The difference between the two time values. |
Example:
const startDatetime = new SimpleDateTime('2019-10-25 08:00:00');
const endDatetime = new SimpleDateTime('2019-10-29 08:00:00');
const schedule = new SimpleSchedule('157165292607666710');
const duration = schedule.duration(startDatetime, endDatetime);
ss.info(duration.getValue());
load(sysId, timeZoneTitle)
This method initializes a schedule by 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:
const schedule = new SimpleSchedule();
schedule.load('157165292607666710');
getname()
This method returns the schedule name.
Return:
| Type | Description |
|---|---|
| String | The schedule name. |
Example:
const schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.getName()); // Info: 8x5 excluding Russian Holidays
isValid()
This method determines if the specified schedule is valid.
Return:
| Type | Description |
|---|---|
| Boolean | This method returns TRUE if the schedule is valid; otherwise, it returns FALSE. |
Example:
const schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.isValid()); // Info: true
isInSchedule(datetime)
This method determines if the given datetime is within the current schedule.
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; otherwise, it returns FALSE. |
Example:
const datetime = new SimpleDateTime();
const schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.isInSchedule(datetime)); // Info: false
setTimeZone(timeZoneTitle)
This method sets a time zone.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| timeZoneTitle | String | Y | N |
Return:
| Type | Description |
|---|---|
| Void | This method does not return a value. |
Example:
const schedule = new SimpleSchedule('157165292607666710');
schedule.setTimeZone('US/Central');
whenNext(datetime, timeZoneTitle)
This method determines how much time (in seconds) is left until next schedule item starts.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| datetime | SimpleDateTime | Y | N |
| timeZoneTitle | String | N | '' |
Return:
| Type | Description |
|---|---|
| SimpleDuration | The SimpleDuration object |
Example:
const startDatetime = new SimpleDateTime('2019-10-25 08:00:00');
const schedule = new SimpleSchedule('157165292607666710');
ss.info(schedule.whenNext(startDatetime));
whenWillExpire(startDateTime, finalWorkingSeconds)
This method determines the time after working seconds value specified in the finalWorkingSeconds parameter passes.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| startDate | SimpleDateTime | Y | N |
| finalWorkingSeconds | Integer | Y | N |
Return:
| Type | Description |
|---|---|
| SimpleDateTime | The SimpleDateTime object |
Example:
const startDatetime = new SimpleDateTime('2019-10-25 08:00:00'); // UTC datetime
const finalWorkingSeconds = 600; // 10 minutes
const schedule = new SimpleSchedule('157165292607666710'); // schedule ID
ss.info(schedule.whenWillExpire(startDatetime, finalWorkingSeconds).getValue()); // Info: 2019-10-25 08:10:00
- No labels
