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;
- 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:
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)
Parameter(s):
| Name | Type |
|---|---|
Return:
| Type | Description |
|---|---|
Example:
| Метод | Описание метода |
| load(sysId, timeZone) | Описание: Инициализирует расписание по sys_id. Принимает: sysId - integer; (опционально) timeZone - string (по умолчанию - пустая строка). Пример: let simple_schedule = new SimpleSchedule(); simple_schedule.load('1'); |
| getName() | Описание: Возвращает имя расписания. Принимает: Ничего. Пример: let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow'); |
| isValid() | Описание: Проверяет, есть ли записи для выбранного расписания. Принимает: Ничего. Пример: let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow'); |
| isInSchedule(time) | Описание: Определяет, находится ли данное время в текущем расписании. Принимает: SimpleDateTime. Возвращает: boolean. Пример: let time = new SimpleDateTime(); |
| isWorkingTime(time) | Описание: Определяет, является время рабочим или нет. Принимает: SimpleDateTime. Пример: let time = new SimpleDateTime(); Не выносить в документацию |
| setTimeZone(timeZone) | Описание: Устанавливает тайм-зону. Принимает: string. Пример: let time = new SimpleDateTime(); |
| whenWillExpire(startDate, finalWorkingSeconds) | Описание: Определяет, когда истекает указанное рабочее время. Принимает:startDate - SimpleDateTime, finalWorkingSeconds - integer Пример: let startDate = new SimpleDateTime('2019-10-25 08:00:00'); |
| whenNext(time, timeZone) | Описание: Определяет, сколько времени (в секундах) до времени начала следующего элемента расписания. Принимает: time - SimpleDateTime; (опционально) timeZone - string (по умолчанию - пустая строка). Возвращает: integer. Пример: let startDate = new SimpleDateTime('2019-10-25 08:00:00'); |
Parameter(s):
| Name | Type |
|---|---|
Return:
| Type | Description |
|---|---|
Example:
