TESSA Web API
    Preparing search index...

    Interface ICardValidationContext

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

    interface ICardValidationContext {
        cardMetadata: ICardMetadata;
        externalContextInfo: IStorage;
        forceWarnings: boolean;
        limitations: ICardValidationLimitationManager;
        mainCard: Card;
        mainCardMetadata: ICardTypeMetadata;
        mainCardMetadataBinder: null | ICardMetadataBinder;
        mainCardType: CardType;
        session: ISession;
        storeMode: CardStoreMode;
        taskCard: null | Card;
        taskCardMetadata: null | ICardTypeMetadata;
        taskCardMetadataBinder: null | ICardMetadataBinder;
        taskCardType: null | CardType;
        validationMode: CardValidationMode;
        buildResult(): ICardValidationResult;
        getCardValidator(): IValidationResultBuilder;
        getEntryFieldValidator(
            sectionName: string,
            fieldName: string,
        ): IValidationResultBuilder;
        getSectionValidator(sectionName: string): IValidationResultBuilder;
        getTableFieldValidator(
            sectionName: string,
            rowIndex: number,
            fieldName: string,
        ): IValidationResultBuilder;
        getTableRowValidator(
            sectionName: string,
            rowIndex: number,
        ): IValidationResultBuilder;
    }

    Implemented by

    Index

    Properties

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

    Methods

    buildResult getCardValidator getEntryFieldValidator getSectionValidator getTableFieldValidator getTableRowValidator

    Properties

    cardMetadata: ICardMetadata

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

    externalContextInfo: IStorage

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

    forceWarnings: boolean

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

    limitations: ICardValidationLimitationManager

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

    mainCard: Card

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

    mainCardMetadata: ICardTypeMetadata

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

    mainCardMetadataBinder: null | ICardMetadataBinder

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

    mainCardType: CardType

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

    session: ISession

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

    storeMode: CardStoreMode

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

    taskCard: null | Card

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

    taskCardMetadata: null | ICardTypeMetadata

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

    taskCardMetadataBinder: null | ICardMetadataBinder

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

    taskCardType: null | CardType

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

    validationMode: CardValidationMode

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

    Methods

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

      Returns ICardValidationResult

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

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

      Returns IValidationResultBuilder

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

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

      Parameters

      • sectionName: string

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

      • fieldName: string

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

      Returns IValidationResultBuilder

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

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

      Parameters

      • sectionName: string

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

      Returns IValidationResultBuilder

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

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

      Parameters

      • sectionName: string

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

      • rowIndex: number

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

      • fieldName: string

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

      Returns IValidationResultBuilder

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

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

      Parameters

      • sectionName: string

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

      • rowIndex: number

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

      Returns IValidationResultBuilder

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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods