Class WorkflowQueue

Очередь обработки сигналов.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

infoKey itemsKey

Accessors

info isEmpty items

Methods

addSignal clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetInfo tryGetItems validate

Constructors

constructor

Static Keys Properties

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly itemsKey

itemsKey: "Items" = 'Items'

Accessors

info

  • get info(): IStorage<unknown>

  • Дополнительная пользовательская информация.

    Returns IStorage<unknown>

  • set info(value: IStorage<unknown>): void

  • Parameters

    Returns void

isEmpty

  • get isEmpty(): boolean

  • Возвращает признак того, что объект не содержит сигналов.

    Returns boolean

items

Methods

addSignal

  • Добавляет запись в очередь, которая описывает сигнал.

    Returns

    Добавленная в очередь запись.

    Parameters

    • args: {
          name?: string;
          number?: number;
          parameters?: IStorage<unknown>;
          processId?: string;
          processTypeName: string;
          queueEventType?: CardWorkflowSignalType;
          type?: WorkflowQueueEventType;
      }

      Параметры сигнала.

      • Optional name?: string

        Имя (алиас) сигнала, с которым может быть связана произвольная логика обработки, т.е. сигналы одного типа с разными именами могут обрабатываться по-разному.

      • Optional number?: number

        Номер сигнала, по которому может определяться способ его прохождения. Можно задать совместно или вместо имени сигнала name.

      • Optional parameters?: IStorage<unknown>

        Параменты сигнала, влияющие на способ его обработки.

      • Optional processId?: string

        Идентификатор подпроцесса, к которому относится сигнал, или null, если подпроцесс определяется не по идентификатору, а по имени типа processTypeName.

      • processTypeName: string

        Имя типа подпроцесса, на экземпляр которого отправляется сигнал. Актуально для процессов, существующих в единственном экземпляре для карточки.

      • Optional queueEventType?: CardWorkflowSignalType

        Тип события по обработке сигнала, определяет момент времени, в который выполняется обработка. По умолчанию выполняется в событие AfterPlatform

      • Optional type?: WorkflowQueueEventType

        Тип сигнала, влияет на способ его обработки. По умолчанию используется WorkflowSignalTypes.Default.

    Returns WorkflowQueueItem

clean

  • Выполняет очистку хранилища от избыточных данных.

    Returns void

clone

  • Создает новый объект, который является копией текущего экземпляра.

    Returns WorkflowQueue

ensureCacheResolved

  • Выполняет резолв кеша декораторов для данных объекта-хранилища.

    Returns void

getStorage

  • Возвращает хранилище IStorage, декоратором для которого является текущий объект.

    Returns

    Хранилище IStorage, декоратором для которого является текущий объект.

    Returns IStorage<unknown>

getStorageSettings

isValid

  • Выполняет проверку объекта на валидность и возвращает признак того, что объект является валидным.

    Returns

    true, если объект прошёл проверку на валидность; false в противном случае.

    Returns boolean

notifyStorageUpdated

  • Метод, уведомляющий объект о наличии изменений в его хранилище.

    Returns void

removeSystemInfo

  • Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.systemKeyPrefix.

    Returns void

removeUserInfo

  • Удаляет пользовательскую информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.userKeyPrefix.

    Returns void

tryGetInfo

  • Возвращает дополнительную пользовательскую информацию по текущему объекту или null, если информация ещё не была задана.

    Returns

    Дополнительная пользовательская информацию по текущему объекту или null, если информация ещё не была задана.

    Returns null | IStorage<unknown>

tryGetItems

  • Возвращает список сигналов в порядке их поступления или null, если список ещё не был задан.

    Returns

    Список сигналов в порядке их поступления null, если список ещё не был задан.

    Returns null | StorageArray<WorkflowQueueItem>

validate

  • Выполняет валидацию текущего объекта и всех его дочерних объектов.

    Returns

    Объект, выполняющий построение результата валидации.

    Returns ValidationResult

Generated using TypeDoc