Interface ICardValidationContext

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

Hierarchy

  • ICardValidationContext

Implemented by

Properties

cardMetadata externalContextInfo forceWarnings limitations mainCard mainCardMetadataBinder mainCardType session storeMode taskCard taskCardMetadataBinder taskCardType validationMode

Methods

buildResult getCardValidator getEntryFieldValidator getSectionValidator getTableFieldValidator getTableRowValidator

Properties

Readonly cardMetadata

cardMetadata: ICardMetadata

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

Readonly externalContextInfo

externalContextInfo: IStorage<unknown>

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

forceWarnings

forceWarnings: boolean

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

Readonly limitations

limitations: ICardValidationLimitationManager

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

Readonly mainCard

mainCard: Card

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

mainCardMetadataBinder

mainCardMetadataBinder: null | ICardMetadataBinder

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

Readonly mainCardType

mainCardType: CardType

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

Readonly session

session: ISession

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

Readonly storeMode

storeMode: CardStoreMode

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

Readonly taskCard

taskCard: null | Card

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

taskCardMetadataBinder

taskCardMetadataBinder: null | ICardMetadataBinder

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

Readonly taskCardType

taskCardType: null | CardType

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

Readonly validationMode

validationMode: CardValidationMode

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

Methods

buildResult

  • Выполняет построение результата валидации карточки.

    Returns

    Результат валидации карточки.

    Returns ICardValidationResult

getCardValidator

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

    Returns

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

    Returns IValidationResultBuilder

getEntryFieldValidator

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

    Returns

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

    Parameters

    • sectionName: string

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

    • fieldName: string

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

    Returns IValidationResultBuilder

getSectionValidator

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

    Returns

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

    Parameters

    • sectionName: string

      Имя проверяемой секции.

    Returns IValidationResultBuilder

getTableFieldValidator

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

    Returns

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

    Parameters

    • sectionName: string

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

    • rowIndex: number

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

    • fieldName: string

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

    Returns IValidationResultBuilder

getTableRowValidator

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

    Returns

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

    Parameters

    • sectionName: string

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

    • rowIndex: number

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

    Returns IValidationResultBuilder

Generated using TypeDoc