TESSA Web API
    Preparing search index...

    Class WorkflowQueueSignal

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties - Other

    cachedMemberChanged fieldChanged

    Properties - Static Keys

    idKey infoKey nameKey numberKey parametersKey processIdKey processTypeNameKey typeIdKey typeNameKey

    Accessors

    cachedMembers id info isObservable name number parameters processId processTypeName typeId typeName

    Methods

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

    Constructors

    Properties - Other

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

    Properties - Static Keys

    idKey: "ID" = 'ID'
    infoKey: "Info" = 'Info'
    nameKey: "Name" = 'Name'
    numberKey: "Number" = 'Number'
    parametersKey: "Parameters" = 'Parameters'
    processIdKey: "ProcessID" = 'ProcessID'
    processTypeNameKey: "ProcessTypeName" = 'ProcessTypeName'
    typeIdKey: "TypeID" = 'TypeID'
    typeNameKey: "TypeName" = 'TypeName'

    Accessors

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

      Returns ReadonlyMap<string, unknown>

    • get id(): string

      Идентификатор сигнала.

      Returns string

    • set id(value: string): void

      Parameters

      • value: string

      Returns void

    • get info(): IStorage

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

      Returns IStorage

    • set info(value: IStorage): void

      Parameters

      Returns void

    • get isObservable(): boolean

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

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

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

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get name(): null | string

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

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get number(): number

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

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

      Returns number

    • set number(value: number): void

      Parameters

      • value: number

      Returns void

    • get parameters(): IStorage

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

      Returns IStorage

    • set parameters(value: IStorage): void

      Parameters

      Returns void

    • get processId(): null | string

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

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get processTypeName(): null | string

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

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

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get typeId(): string

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

      Returns string

    • set typeId(value: string): void

      Parameters

      • value: string

      Returns void

    • get typeName(): string

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

      Returns string

    • set typeName(value: string): void

      Parameters

      • value: string

      Returns void

    Methods

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

      Returns void

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

      Returns WorkflowQueueSignal

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

      Returns void

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

      Returns IStorage

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

    • Returns boolean

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

      Returns boolean

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

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

      Returns void

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

      Returns void

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

      Returns void

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

      Returns null | IStorage

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

    • Returns null | IStorage

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods