TESSA Web API
    Preparing search index...

    Class Operation

    Операция.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    cachedMemberChanged fieldChanged

    Accessors

    cachedMembers completed created createdById creationFlags digest hash id inProgress isObservable jsonStatus objectId postponed progress request response sessionId state typeId

    Methods

    clean ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated validate

    Constructors

    • Создает операцию с параметрами по умолчанию.

      Returns Operation

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

      Parameters

      • operation: IOperation

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

      Returns Operation

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

      Parameters

      • storage: IStorage

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

      Returns Operation

    Properties

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

    Accessors

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

      Returns ReadonlyMap<string, unknown>

    • get completed(): null | string

      Дата и время окончания операции в UTC или null, если операция ещё не завершена.

      Returns null | string

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

      Дата и время окончания операции в UTC или null, если операция ещё не завершена.

      Parameters

      • value: null | string

      Returns void

    • get created(): string

      Дата и время создания операции в UTC.

      Returns string

    • set created(value: string): void

      Дата и время создания операции в UTC.

      Parameters

      • value: string

      Returns void

    • get createdById(): string

      Идентификатор пользователя, создавшего запрос на операцию.

      Returns string

    • set createdById(value: string): void

      Идентификатор пользователя, создавшего запрос на операцию.

      Parameters

      • value: string

      Returns void

    • get digest(): null | string

      Краткое описание операции.

      Returns null | string

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

      Краткое описание операции.

      Parameters

      • value: null | string

      Returns void

    • get hash(): null | string

      Хеш, посчитанный для типа операции typeId, для объекта objectId и для данных в запросе request, или null, если хеш не был рассчитан для этой операции (операция создана в предыдущих версиях системы).

      Для расчёта обычно используется функция хеширования HMAC-SHA256, размер хеша в которой 256 бит или 32 байта.

      Расчёт выполняется автоматически в момент создания операции. Заполнять поле вручную не рекомендуется.

      Returns null | string

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

      Хеш, посчитанный для типа операции typeId, для объекта objectId и для данных в запросе request, или null, если хеш не был рассчитан для этой операции (операция создана в предыдущих версиях системы).

      Для расчёта обычно используется функция хеширования HMAC-SHA256, размер хеша в которой 256 бит или 32 байта.

      Расчёт выполняется автоматически в момент создания операции. Заполнять поле вручную не рекомендуется.

      Parameters

      • value: null | string

      Returns void

    • get id(): string

      Идентификатор операции.

      Returns string

    • set id(value: string): void

      Идентификатор операции.

      Parameters

      • value: string

      Returns void

    • get inProgress(): null | string

      Дата и время начала выполнения операции в UTC или null, если выполнение операции ещё не начато.

      Returns null | string

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

      Дата и время начала выполнения операции в UTC или null, если выполнение операции ещё не начато.

      Parameters

      • value: null | string

      Returns void

    • get isObservable(): boolean

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

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

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

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get jsonStatus(): null | string

      Статус выполнения операции в формате JSON, имеющего произвольную структуру.

      Returns null | string

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

      Статус выполнения операции в формате JSON, имеющего произвольную структуру.

      Parameters

      • value: null | string

      Returns void

    • get objectId(): null | string

      Идентификатор объекта, с которым связана операция (обычно это идентификатор карточки или файла). Может быть не указан. Влияет на расчёт хеша hash.

      Returns null | string

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

      Идентификатор объекта, с которым связана операция (обычно это идентификатор карточки или файла). Может быть не указан. Влияет на расчёт хеша hash.

      Parameters

      • value: null | string

      Returns void

    • get postponed(): null | string

      Дата и время, до наступления которого операция отложена, или null, если операция не отложена.

      Returns null | string

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

      Дата и время, до наступления которого операция отложена, или null, если операция не отложена.

      Parameters

      • value: null | string

      Returns void

    • get progress(): null | number

      Процент выполнения операции от 0 до 100 или null, если операция не сообщает процент своей готовности.

      Returns null | number

    • set progress(value: null | number): void

      Процент выполнения операции от 0 до 100 или null, если операция не сообщает процент своей готовности.

      Parameters

      • value: null | number

      Returns void

    • get request(): null | OperationRequest

      Запрос на выполнение операции или null, если для выполнения операции не требуется запрос.

      Returns null | OperationRequest

    • set request(value: null | OperationRequest): void

      Запрос на выполнение операции или null, если для выполнения операции не требуется запрос.

      Parameters

      Returns void

    • get response(): null | OperationResponse

      Результат выполнения операции или null, если операция ещё не завершена или для операции недоступна информация о результате.

      Returns null | OperationResponse

    • set response(value: null | OperationResponse): void

      Результат выполнения операции или null, если операция ещё не завершена или для операции недоступна информация о результате.

      Parameters

      Returns void

    • get sessionId(): string

      Идентификатор сессии, в рамках которой была создана операция.

      Returns string

    • set sessionId(value: string): void

      Идентификатор сессии, в рамках которой была создана операция.

      Parameters

      • value: string

      Returns void

    • get typeId(): string

      Идентификатор типа операции. Должен быть добавлен в таблицу-перечисление OperationTypes.

      Returns string

    • set typeId(value: string): void

      Идентификатор типа операции. Должен быть добавлен в таблицу-перечисление OperationTypes.

      Parameters

      • value: string

      Returns void

    Methods

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

      Returns void

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

      Returns void

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

      Returns IStorage

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

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

      Returns boolean

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

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

      Returns void

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods