Class WorkflowQueueItem

Действие с номером в очереди WorkflowQueue.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

handledKey idKey infoKey queueEventTypeIdKey queueEventTypeNameKey signalKey

Accessors

handled id info queueEventTypeId queueEventTypeName signal

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isEmpty isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetInfo tryGetSignal validate

Constructors

constructor

Static Keys Properties

Static Readonly handledKey

handledKey: "Handled" = 'Handled'

Static Readonly idKey

idKey: "ID" = 'ID'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly queueEventTypeIdKey

queueEventTypeIdKey: "QueueEventTypeID" = 'QueueEventTypeID'

Static Readonly queueEventTypeNameKey

queueEventTypeNameKey: "QueueEventTypeName" = 'QueueEventTypeName'

Static Readonly signalKey

signalKey: "Signal" = 'Signal'

Accessors

handled

  • get handled(): boolean

  • Признак того, что действие обработано. Обработанные действия не будут обработаны повторно и могут быть удалены из очереди после завершения цепочки действий.

    Returns boolean

  • set handled(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

id

  • get id(): string

  • Идентификатор записи.

    Returns string

  • set id(value: string): void

  • Parameters

    • value: string

    Returns void

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

queueEventTypeId

  • get queueEventTypeId(): string

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

    Returns string

  • set queueEventTypeId(value: string): void

  • Parameters

    • value: string

    Returns void

queueEventTypeName

  • get queueEventTypeName(): string

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

    Returns string

  • set queueEventTypeName(value: string): void

  • Parameters

    • value: string

    Returns void

signal

  • get signal(): WorkflowQueueSignal

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

    Returns WorkflowQueueSignal

  • set signal(value: WorkflowQueueSignal): void

  • Parameters

    Returns void

Methods

clean

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

    Returns void

clone

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

    Returns WorkflowQueueItem

ensureCacheResolved

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

    Returns void

getStorage

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

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

isEmpty

  • Returns boolean

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>

tryGetSignal

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

    Returns

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

    Returns null | WorkflowQueueSignal

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc