You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 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;
  • setting time zone for the schedule.


Parameter(s):

NameType



Return:

TypeDescription



Example:


Класс: SimpleSchedule.
Тип: Серверный.
Описание: Класс предоставляет методы для выполнения операций над объектами SimpleSchedule, таких как добавление новых сегментов расписания в расписание, определение того, находится ли дата-время в расписании, или установка часового пояса расписания.

МетодОписание метода
duration(startDate, endDate)

Описание: Определяет рабочее время в секундах расписания между двумя значениями даты и времени,
используя часовой пояс расписания или, если он не указан, часовой пояс сеанса.

Принимает: SimpleDateTime.
Возвращает: SimpleDuration.

Пример:

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)

Описание: Инициализирует расписание по sys_id.

Принимает: sysId - integer; (опционально) timeZone - string (по умолчанию - пустая строка).
Возвращает: Ничего.

Пример:

let simple_schedule = new SimpleSchedule();

simple_schedule.load('1');

getName()

Описание: Возвращает имя расписания.

Принимает: Ничего.
Возвращает: string.

Пример:

let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.getName());

isValid()

Описание: Проверяет, есть ли записи для выбранного расписания.

Принимает: Ничего.
Возвращает: boolean.

Пример:

let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.isValid());

isInSchedule(time)

Описание: Определяет, находится ли данное время в текущем расписании.

Принимает: SimpleDateTime.

Возвращает: boolean.

Пример:

let time = new SimpleDateTime();
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.isInSchedule(time));

isWorkingTime(time)

Описание: Определяет, является время рабочим или нет.

Принимает: SimpleDateTime.
Возвращает: boolean.

Пример:

let time = new SimpleDateTime();
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.isWorkingTime(time));

Не выносить в документацию

setTimeZone(timeZone)

Описание: Устанавливает тайм-зону.

Принимает: string.
Возвращает: Ничего.

Пример:

let time = new SimpleDateTime();
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
simple_schedule.setTimeZone('US/Central');

whenWillExpire(startDate, finalWorkingSeconds)

Описание: Определяет, когда истекает указанное рабочее время.

Принимает:startDate - SimpleDateTime, finalWorkingSeconds - integer
Возвращает: false|string.

Пример:

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)

Описание: Определяет, сколько времени (в секундах) до времени начала следующего элемента расписания.

Принимает: time - SimpleDateTime; (опционально) timeZone - string (по умолчанию - пустая строка).

Возвращает: integer.

Пример:

let startDate = new SimpleDateTime('2019-10-25 08:00:00');
let simple_schedule = new SimpleSchedule('1', 'Europe/Moscow');
ss.info(simple_schedule.whenNext(startDate));



  • No labels