TESSA Web API
    Preparing search index...

    Class WorkflowQueue

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties - Other

    cachedMemberChanged fieldChanged

    Properties - Static Keys

    infoKey itemsKey

    Accessors

    cachedMembers info isEmpty isObservable items

    Methods

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

    Constructors

    Properties - Other

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

    Properties - Static Keys

    infoKey: "Info" = 'Info'
    itemsKey: "Items" = 'Items'

    Accessors

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

      Returns ReadonlyMap<string, unknown>

    • get info(): IStorage

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

      Returns IStorage

    • set info(value: IStorage): void

      Parameters

      Returns void

    • get isEmpty(): boolean

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

      Returns boolean

    • get isObservable(): boolean

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

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

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

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

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

      Parameters

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

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

        • Optionalname?: string

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

        • Optionalnumber?: number

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

        • Optionalparameters?: IStorage

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

        • OptionalprocessId?: string

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

        • processTypeName: string

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

        • OptionalqueueEventType?: CardWorkflowSignalType

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

        • Optionaltype?: WorkflowQueueEventType

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

      Returns WorkflowQueueItem

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

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

      Returns void

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

      Returns WorkflowQueue

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

      Returns void

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

      Returns IStorage

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

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

      Returns boolean

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

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

      Returns void

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

      Returns void

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

      Returns void

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

      Returns null | IStorage

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

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

      Returns null | StorageArray<WorkflowQueueItem>

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

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods