Class CardDeleteResponse

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

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

cardTypeIdKey cardTypeNameKey infoKey systemDeletedCardIdKey systemRestoredCardIdKey validationResultKey

Accessors

cardTypeId cardTypeName deletedCardId info restoredCardId validationResult

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetInfo tryGetValidationResult validate

Constructors

constructor

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

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns CardDeleteResponse

Static Keys Properties

Static Readonly cardTypeIdKey

cardTypeIdKey: "CardTypeID" = 'CardTypeID'

Static Readonly cardTypeNameKey

cardTypeNameKey: "CardTypeName" = 'CardTypeName'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly systemDeletedCardIdKey

systemDeletedCardIdKey: string = ...

Static Readonly systemRestoredCardIdKey

systemRestoredCardIdKey: string = ...

Static Readonly validationResultKey

validationResultKey: "ValidationResult" = 'ValidationResult'

Accessors

cardTypeId

  • get cardTypeId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

cardTypeName

  • get cardTypeName(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

deletedCardId

  • get deletedCardId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

restoredCardId

  • get restoredCardId(): null | string

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

    Returns null | string

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

  • Parameters

    • value: null | string

    Returns void

validationResult

Methods

clean

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

    Returns void

clone

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

    Returns CardDeleteResponse

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>

tryGetValidationResult

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

    Returns

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

    Returns null | ValidationStorageResultBuilder

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc