Class CardGetRequest

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

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

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

Accessors

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

Methods

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

Constructors

constructor

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

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns CardGetRequest

Static Keys Properties

Static Readonly cardIdKey

cardIdKey: "CardID" = 'CardID'

Static Readonly cardTypeIdKey

cardTypeIdKey: "CardTypeID" = 'CardTypeID'

Static Readonly cardTypeNameKey

cardTypeNameKey: "CardTypeName" = 'CardTypeName'

Static Readonly compressionModeKey

compressionModeKey: "CompressionMode" = 'CompressionMode'

Static Readonly exportFormatKey

exportFormatKey: "ExportFormat" = 'ExportFormat'

Static Readonly getModeKey

getModeKey: "GetMode" = 'GetMode'

Static Readonly getTaskModeKey

getTaskModeKey: "GetTaskMode" = 'GetTaskMode'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly newModeKey

newModeKey: "NewMode" = 'NewMode'

Static Readonly restrictionFlagsKey

restrictionFlagsKey: "RestrictionFlags" = 'RestrictionFlags'

Static Readonly sectionsToExcludeKey

sectionsToExcludeKey: "SectionsToExclude" = 'SectionsToExclude'

Static Readonly systemMethodKey

systemMethodKey: string = ...

Static Readonly tasksToUnlockRowIdListKey

tasksToUnlockRowIdListKey: "TasksToUnlockRowIDList" = 'TasksToUnlockRowIDList'

Accessors

cardId

  • get cardId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

cardTypeId

  • get cardTypeId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

cardTypeName

  • get cardTypeName(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

compressionMode

exportFormat

  • get exportFormat(): CardFileFormat

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

    Returns CardFileFormat

  • set exportFormat(value: CardFileFormat): void

  • Parameters

    Returns void

getMode

  • get getMode(): CardGetMode

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

    Returns CardGetMode

  • set getMode(value: CardGetMode): void

  • Parameters

    Returns void

getTaskMode

  • get getTaskMode(): CardGetTaskMode

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

    Returns CardGetTaskMode

  • set getTaskMode(value: CardGetTaskMode): void

  • Parameters

    Returns void

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

method

  • get method(): CardGetMethod

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

    Returns CardGetMethod

  • set method(value: CardGetMethod): void

  • Parameters

    Returns void

newMode

  • get newMode(): CardNewMode

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

    Returns CardNewMode

  • set newMode(value: CardNewMode): void

  • Parameters

    Returns void

restrictionFlags

  • get restrictionFlags(): CardGetRestrictionFlags

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

    Returns CardGetRestrictionFlags

  • set restrictionFlags(value: CardGetRestrictionFlags): void

  • Parameters

    Returns void

sectionsToExclude

  • get sectionsToExclude(): TypedStorageArray<String, string>

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

    Returns TypedStorageArray<String, string>

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

  • Parameters

    • value: string[]

    Returns void

tasksToUnlockRowIdList

  • get tasksToUnlockRowIdList(): TypedStorageArray<Guid, string>

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

    Returns TypedStorageArray<Guid, string>

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

  • Parameters

    • value: string[]

    Returns void

Methods

clean

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

    Returns void

clone

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

    Returns CardGetRequest

ensureCacheResolved

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

    Returns void

getStorage

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

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

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>

tryGetSectionsToExclude

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

    Returns

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

    Returns null | TypedStorageArray<String, string>

tryGetTasksToUnlockRowIdList

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

    Returns

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

    Returns null | TypedStorageArray<Guid, string>

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc