TESSA Web API
    Preparing search index...

    Class CardGetRequest

    Запрос на получение информации по карточке от сервиса карточек.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties - Other

    cachedMemberChanged fieldChanged

    Properties - Static Keys

    cardIdKey cardTypeIdKey cardTypeNameKey exportFormatKey getModeKey getTaskModeKey infoKey newModeKey restrictionFlagsKey sectionsToExcludeKey systemMethodKey tasksToUnlockRowIdListKey

    Accessors

    cachedMembers cardId cardTypeId cardTypeName exportFormat getMode getTaskMode info isObservable method newMode restrictionFlags sectionsToExclude tasksToUnlockRowIdList

    Methods

    clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetInfo tryGetSectionsToExclude tryGetTasksToUnlockRowIdList validate

    Constructors

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

      Parameters

      • storage: IStorage = {}

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

      Returns CardGetRequest

    Properties - Other

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

    Properties - Static Keys

    cardIdKey: "CardID" = 'CardID'
    cardTypeIdKey: "CardTypeID" = 'CardTypeID'
    cardTypeNameKey: "CardTypeName" = 'CardTypeName'
    exportFormatKey: "ExportFormat" = 'ExportFormat'
    getModeKey: "GetMode" = 'GetMode'
    getTaskModeKey: "GetTaskMode" = 'GetTaskMode'
    infoKey: "Info" = 'Info'
    newModeKey: "NewMode" = 'NewMode'
    restrictionFlagsKey: "RestrictionFlags" = 'RestrictionFlags'
    sectionsToExcludeKey: "SectionsToExclude" = 'SectionsToExclude'
    systemMethodKey: string = ...
    tasksToUnlockRowIdListKey: "TasksToUnlockRowIDList" = 'TasksToUnlockRowIDList'

    Accessors

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

      Returns ReadonlyMap<string, unknown>

    • get cardId(): null | string

      Идентификатор запрашиваемой карточки или null, если запрашивается виртуальная карточка, идентификатор которой задаётся другим способом.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get cardTypeId(): null | string

      Идентификатор типа карточки. Значение необязательно для заполнения.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get cardTypeName(): null | string

      Имя типа карточки. Значение необязательно для заполнения.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get exportFormat(): CardFileFormat

      Флаги, ограничивающие загружаемую по карточке информацию. По умолчанию загружаемая информация не ограничивается.

      Returns CardFileFormat

    • set exportFormat(value: CardFileFormat): void

      Parameters

      Returns void

    • get getMode(): CardGetMode

      Способ открытия карточки.

      Returns CardGetMode

    • set getMode(value: CardGetMode): void

      Parameters

      Returns void

    • get getTaskMode(): CardGetTaskMode

      Способ загрузки заданий в открываемой карточке.

      Returns CardGetTaskMode

    • set getTaskMode(value: CardGetTaskMode): void

      Parameters

      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 method(): CardGetMethod

      Способ загрузки карточки.

      Returns CardGetMethod

    • set method(value: CardGetMethod): void

      Parameters

      Returns void

    • get newMode(): CardNewMode

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

      Returns CardNewMode

    • set newMode(value: CardNewMode): void

      Parameters

      Returns void

    • get restrictionFlags(): CardGetRestrictionFlags

      Флаги, ограничивающие загружаемую по карточке информацию. По умолчанию загружаемая информация не ограничивается.

      Returns CardGetRestrictionFlags

    • set restrictionFlags(value: CardGetRestrictionFlags): void

      Parameters

      Returns void

    • get sectionsToExclude(): TypedStorageArray<String>

      Список имён физических секций, которые не следует загружать. Не влияет на виртуальные секции.

      Returns TypedStorageArray<String>

    • set sectionsToExclude(value: string[]): void

      Parameters

      • value: string[]

      Returns void

    • get tasksToUnlockRowIdList(): TypedStorageArray<Guid>

      Список идентификаторов заданий, все данные которых будут полностью загружены, если такие задания доступны от имени автора.

      Returns TypedStorageArray<Guid>

    • set tasksToUnlockRowIdList(value: string[]): void

      Parameters

      • value: string[]

      Returns void

    Methods

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

      Returns void

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

      Returns CardGetRequest

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

      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 | TypedStorageArray<String, string>

      Список имён физических секций, которые не следует загружать, или null, если список ещё не был задан.

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

      Returns null | TypedStorageArray<Guid, string>

      Список идентификаторов заданий.

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods