Class WorkflowQueueItem

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

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties - Other

cachedMemberChanged fieldChanged

Properties - Static Keys

handledKey idKey infoKey queueEventTypeIdKey queueEventTypeNameKey signalKey

Accessors

cachedMembers handled id info isObservable queueEventTypeId queueEventTypeName signal

Methods

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

Constructors

constructor

Properties - Other

ReadonlycachedMemberChanged

cachedMemberChanged: EventHandler<
    { fieldName: string; newValue: unknown; oldValue: unknown },
>

ReadonlyfieldChanged

fieldChanged: EventHandler<
    { fieldName: string; newValue: unknown; oldValue: unknown },
>

Properties - Static Keys

Static ReadonlyhandledKey

handledKey: "Handled" = 'Handled'

Static ReadonlyidKey

idKey: "ID" = 'ID'

Static ReadonlyinfoKey

infoKey: "Info" = 'Info'

Static ReadonlyqueueEventTypeIdKey

queueEventTypeIdKey: "QueueEventTypeID" = 'QueueEventTypeID'

Static ReadonlyqueueEventTypeNameKey

queueEventTypeNameKey: "QueueEventTypeName" = 'QueueEventTypeName'

Static ReadonlysignalKey

signalKey: "Signal" = 'Signal'

Accessors

cachedMembers

  • get cachedMembers(): ReadonlyMap<string, unknown>

    Returns ReadonlyMap<string, unknown>

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

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

    Returns IStorage

  • set info(value: IStorage): void

    Parameters

    Returns void

isObservable

  • get isObservable(): boolean

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

    Если значение этого свойства равно true, то объект класса может быть подписан на изменения, и соответствующие обработчики будут вызываться при каждом изменении состояния объекта.

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

    Returns boolean

  • set isObservable(value: boolean): void

    Parameters

    • value: boolean

    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

  • clean(): void

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

    Returns void

clone

  • clone(): WorkflowQueueItem

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

    Returns WorkflowQueueItem

ensureCacheResolved

  • ensureCacheResolved(): void

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

    Returns void

getStorage

  • getStorage(): IStorage

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

    Returns IStorage

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

getStorageSettings

isEmpty

  • isEmpty(): boolean

    Returns boolean

isValid

  • isValid(): boolean

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

    Returns boolean

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

notifyStorageUpdated

  • notifyStorageUpdated(): void

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

    Returns void

removeSystemInfo

  • removeSystemInfo(): void

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

    Returns void

removeUserInfo

  • removeUserInfo(): void

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

    Returns void

tryGetInfo

  • tryGetInfo(): null | IStorage

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

    Returns null | IStorage

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

tryGetSignal

  • tryGetSignal(): null | WorkflowQueueSignal

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

    Returns null | WorkflowQueueSignal

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

validate

  • validate(): ValidationResult

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

    Returns ValidationResult

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

Settings

Member Visibility

On This Page

Constructors
Properties - Other
Properties - Static Keys
Accessors
Methods