Class WorkflowQueueSignal

Объект, сохраняющий информацию по сигналу.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

idKey infoKey nameKey numberKey parametersKey processIdKey processTypeNameKey typeIdKey typeNameKey

Accessors

id info name number parameters processId processTypeName typeId typeName

Methods

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

Constructors

constructor

Static Keys Properties

Static Readonly idKey

idKey: "ID" = 'ID'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly nameKey

nameKey: "Name" = 'Name'

Static Readonly numberKey

numberKey: "Number" = 'Number'

Static Readonly parametersKey

parametersKey: "Parameters" = 'Parameters'

Static Readonly processIdKey

processIdKey: "ProcessID" = 'ProcessID'

Static Readonly processTypeNameKey

processTypeNameKey: "ProcessTypeName" = 'ProcessTypeName'

Static Readonly typeIdKey

typeIdKey: "TypeID" = 'TypeID'

Static Readonly typeNameKey

typeNameKey: "TypeName" = 'TypeName'

Accessors

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

name

  • get name(): null | string

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

    По умолчанию значение равно null.

    Returns null | string

  • set name(value: null | string): void

  • Parameters

    • value: null | string

    Returns void

number

  • get number(): number

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

    По умолчанию значение равно 0.

    Returns number

  • set number(value: number): void

  • Parameters

    • value: number

    Returns void

parameters

  • get parameters(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

processId

  • get processId(): null | string

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

    По умолчанию значение равно null.

    Returns null | string

  • set processId(value: null | string): void

  • Parameters

    • value: null | string

    Returns void

processTypeName

  • get processTypeName(): null | string

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

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

    По умолчанию значение равно null.

    Returns null | string

  • set processTypeName(value: null | string): void

  • Parameters

    • value: null | string

    Returns void

typeId

  • get typeId(): string

  • Тип сигнала, влияет на способ его обработки.

    Returns string

  • set typeId(value: string): void

  • Parameters

    • value: string

    Returns void

typeName

  • get typeName(): string

  • Тип сигнала, влияет на способ его обработки.

    Returns string

  • set typeName(value: string): void

  • Parameters

    • value: string

    Returns void

Methods

clean

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

    Returns void

clone

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

    Returns WorkflowQueueSignal

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>

tryGetParameters

  • Returns null | IStorage<unknown>

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc