TESSA Web API
    Preparing search index...

    Interface IValidationResultBuilder

    An object that builds the validation result.

    interface IValidationResultBuilder {
        hasData: boolean;
        isSuccessful: boolean;
        items: readonly IValidationResultItem[];
        add(
            key: ValidationKey,
            type: ValidationResultType,
            message: string | Error,
            fieldName?: null | string,
            objectName?: null | string,
            objectType?: null | string,
            details?: null | string,
        ): IValidationResultBuilder;
        add(validationResult: ValidationResult): IValidationResultBuilder;
        add(
            validationResultBuilder: IValidationResultBuilder,
        ): IValidationResultBuilder;
        build(): ValidationResult;
        clear(): void;
    }

    Implemented by

    Index

    Properties

    hasData: boolean

    Returns an indication that the object contains validation messages.

    isSuccessful: boolean

    Returns an indication that the validation result will succeed when built.

    items: readonly IValidationResultItem[]

    Validation messages.

    Methods

    • Adds an informational message with the specified text.

      Parameters

      • key: ValidationKey

        Key of the validation message.

      • type: ValidationResultType

        Type of the validation message.

      • message: string | Error

        Text of the message or error object that occurred during validation.

      • OptionalfieldName: null | string

        Name of the field of the object to which the validation message refers, or null if the field is unknown.

      • OptionalobjectName: null | string

        Name of the object to which the validation message refers, or null if name is unknown.

      • OptionalobjectType: null | string

        Type of the object to which the validation message refers, or null if type is unknown.

      • Optionaldetails: null | string

        Additional information about the message, such as full text of exception, or null if there is no additional information.

      Returns IValidationResultBuilder

      Текущий объект IValidationResultBuilder.

    • Добавляет копию указанного сообщения валидации.

      Parameters

      • validationResult: ValidationResult

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

      Returns IValidationResultBuilder

      Текущий объект IValidationResultBuilder.

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

      Parameters

      • validationResultBuilder: IValidationResultBuilder

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

      Returns IValidationResultBuilder

      Текущий объект IValidationResultBuilder.

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

      Returns ValidationResult

      Результат валидации.

    • Удаляет все сообщения валидации.

      Returns void