Class CardValidationContext

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

Implements

ICardValidationContext

Constructors

constructor

new CardValidationContext(
    mainCard: Card,
    mainCardType: CardType,
    mainCardMetadata: ICardTypeMetadata,
    storeMode: CardStoreMode,
    taskCard: null | Card,
    taskCardType: null | CardType,
    taskCardMetadata: null | ICardTypeMetadata,
    cardMetadata: ICardMetadata,
    session: ISession,
    externalContextInfo?: null | IStorage,
    limitations?: null | ICardValidationLimitationManager,
    validationMode?: null | CardValidationMode,
    mainCardMetadataBinder?: null | ICardMetadataBinder,
    taskCardMetadataBinder?: null | ICardMetadataBinder,
): CardValidationContext
Parameters
- mainCard: Card
- mainCardType: CardType
- mainCardMetadata: ICardTypeMetadata
- storeMode: CardStoreMode
- taskCard: null | Card
- taskCardType: null | CardType
- taskCardMetadata: null | ICardTypeMetadata
- cardMetadata: ICardMetadata
- session: ISession
- externalContextInfo: null | IStorage = null
- limitations: null | ICardValidationLimitationManager = null
- validationMode: null | CardValidationMode = null
- mainCardMetadataBinder: null | ICardMetadataBinder = null
- taskCardMetadataBinder: null | ICardMetadataBinder = null
Returns CardValidationContext
- Defined in @tessa/platform/src/cards/validation/cardValidationContext.ts:28

Properties

`Readonly`cardMetadata

cardMetadata: ICardMetadata

Метаинформация по типам карточек, используемая в процессе валидации.

`Readonly`externalContextInfo

externalContextInfo: IStorage

Произвольно структурированная информация из внешнего контекста (например, контекста сохранения карточки), которая может быть заполнена валидатором и использована либо другими валидаторами, либо внешними расширениями. Когда внешний контекст неизвестен, будет создан пустой объект, но при этом свойство никогда не возвращает null.

forceWarnings

forceWarnings: boolean = false

Признак того, что валидаторы-предупреждения срабатывают даже в том случае, если они не должны срабатывать, например, на клиенте. Это полезно, если выполняется валидация на клиенте без валидации на сервере.

`Readonly`limitations

limitations: ICardValidationLimitationManager

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

`Readonly`mainCard

mainCard: Card

Основная карточка, для которой выполняется валидация.

`Readonly`mainCardMetadata

mainCardMetadata: ICardTypeMetadata

Метаинформация по типу основной карточки.

mainCardMetadataBinder

mainCardMetadataBinder: null | ICardMetadataBinder

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

`Readonly`mainCardType

mainCardType: CardType

Тип основной карточки, для которой выполняется валидация.

`Readonly`session

session: ISession

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

`Readonly`storeMode

storeMode: CardStoreMode

Способ сохранения проверяемого объекта - карточки, файла или задания.

`Readonly`taskCard

taskCard: null | Card

Карточка задания, валидация которой выполняется, или null, если задание завершается без данных карточки или валидация задания не выполняется.

`Readonly`taskCardMetadata

taskCardMetadata: null | ICardTypeMetadata

Метаинформация по типу карточки задания, или null, если валидация задания не выполняется.

taskCardMetadataBinder

taskCardMetadataBinder: null | ICardMetadataBinder

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

`Readonly`taskCardType

taskCardType: null | CardType

Тип карточки задания, для которой выполняется валидация, или null, если валидация задания не выполняется.

`Readonly`validationMode

validationMode: CardValidationMode

Способ выполнения валидации.

Methods

buildResult

buildResult(): ICardValidationResult
Выполняет построение результата валидации карточки.

Returns ICardValidationResult
Результат валидации карточки.
Implementation of ICardValidationContext.buildResult
- Defined in @tessa/platform/src/cards/validation/cardValidationContext.ts:178

getCardValidator

getCardValidator(): IValidationResultBuilder
Возвращает объект, выполняющий построение результата валидации для всей карточки.

Returns IValidationResultBuilder
Объект, выполняющий построение результата валидации для карточки.
Implementation of ICardValidationContext.getCardValidator
- Defined in @tessa/platform/src/cards/validation/cardValidationContext.ts:174

getEntryFieldValidator

getEntryFieldValidator(
sectionName: string,
fieldName: string,
): IValidationResultBuilder
Возвращает объект, выполняющий построение результата валидации для заданного поля строковой секции.
Parameters
- sectionName: string
  Имя строковой секции, для поля которой выполняется валидация.
- fieldName: string
  Поле заданной строковой секции, для которого выполняется валидация.
Returns IValidationResultBuilder
Объект, выполняющий построение результата валидации для заданного поля.
Implementation of ICardValidationContext.getEntryFieldValidator
- Defined in @tessa/platform/src/cards/validation/cardValidationContext.ts:151

getSectionValidator

getSectionValidator(sectionName: string): IValidationResultBuilder
Возвращает объект, выполняющий построение результата валидации для строковой, коллекционной или древовидной секции карточки.
Parameters
- sectionName: string
  Имя проверяемой секции.
Returns IValidationResultBuilder
Объект, выполняющий построение результата валидации для заданной секции.
Implementation of ICardValidationContext.getSectionValidator
- Defined in @tessa/platform/src/cards/validation/cardValidationContext.ts:170

getTableFieldValidator

getTableFieldValidator(
    sectionName: string,
    rowIndex: number,
    fieldName: string,
): IValidationResultBuilder
Возвращает объект, выполняющий построение результата валидации для заданного поля строки коллекционной или древовидной секции.
Parameters
- sectionName: string
  Имя коллекционной или древовидной секции, для строки которой выполняется валидация.
- rowIndex: number
  Индекс строки заданной коллекционной или древовидной секции, для поля которой выполняется валидация.
- fieldName: string
  Имя поля в строке коллекционной или древовидной секции, для которого выполняется валидация.
Returns IValidationResultBuilder
Объект, выполняющий построение результата валидации для заданного поля.
Implementation of ICardValidationContext.getTableFieldValidator
- Defined in @tessa/platform/src/cards/validation/cardValidationContext.ts:156

getTableRowValidator

getTableRowValidator(
sectionName: string,
rowIndex: number,
): IValidationResultBuilder
Возвращает объект, выполняющий построение результата валидации для строки коллекционной или древовидной секции.
Parameters
- sectionName: string
  Имя коллекционной или древовидной секции, для строки которой выполняется валидация.
- rowIndex: number
  Индекс строки заданной коллекционной или древовидной секции, для которой выполняется валидация.
Returns IValidationResultBuilder
Объект, выполняющий построение результата валидации для заданной строки.
Implementation of ICardValidationContext.getTableRowValidator
- Defined in @tessa/platform/src/cards/validation/cardValidationContext.ts:165

initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in @tessa/platform/src/cards/validation/cardValidationContext.ts:116

Class CardValidationContext

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CardValidationContext

Properties

ReadonlycardMetadata

ReadonlyexternalContextInfo

forceWarnings

Readonlylimitations

ReadonlymainCard

ReadonlymainCardMetadata

mainCardMetadataBinder

ReadonlymainCardType

Readonlysession

ReadonlystoreMode

ReadonlytaskCard

ReadonlytaskCardMetadata

taskCardMetadataBinder

ReadonlytaskCardType

ReadonlyvalidationMode

Methods

buildResult

Returns ICardValidationResult

getCardValidator

Returns IValidationResultBuilder

getEntryFieldValidator

Parameters

Returns IValidationResultBuilder

getSectionValidator

Parameters

Returns IValidationResultBuilder

getTableFieldValidator

Parameters

Returns IValidationResultBuilder

getTableRowValidator

Parameters

Returns IValidationResultBuilder

initialize

Returns Promise<void>

Settings

On This Page

`Readonly`cardMetadata

`Readonly`externalContextInfo

`Readonly`limitations

`Readonly`mainCard

`Readonly`mainCardMetadata

`Readonly`mainCardType

`Readonly`session

`Readonly`storeMode

`Readonly`taskCard

`Readonly`taskCardMetadata

`Readonly`taskCardType

`Readonly`validationMode