Class CardValidationHelperHelper

Hierarchy

  • CardValidationHelper

Methods

addMessage ensureTableSection executeValidators existsInType getObjectName getRemoveDuplicates tryGetColumn tryGetColumnId tryGetOrderColumnId tryGetParentSectionAndColumnId tryGetSection tryGetSectionId

Methods

addMessage

  • Добавляет сообщение валидации для заданного валидатора.

    Parameters

    • validationKey: ValidationKey

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

    • validationParameter: null | string

      Параметр сообщения, например, имя секции или поля, в котором возникла ошибка. Может быть равен null или пустой строке.

    • validator: CardTypeValidator

      Валидатор типа NotNullTable.

    • validationResult: IValidationResultBuilder

      Результат валидации, в который будет добавлено сообщение валидатора.

    • validatorName: string

      Имя экземпляра валидатора.

    Returns void

ensureTableSection

  • Подтверждает, что заданная метаинформация относится к коллекционной или древовидной секции.

    Returns

    true, если заданная метаинформация относится к коллекционной или древовидной секции; false в противном случае.

    Parameters

    • section: ICardMetadataSection

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

    • context: ICardValidationContext

      Контекст валидации.

    • validatorName: string

      Имя экземпляра валидатора.

    Returns boolean

executeValidators

  • Выполняет валидаторы для заданной карточки.

    Parameters

    • card: Card

      Карточка, для которой выполняются валидаторы.

    • cardType: CardType

      Тип карточки, для которого выполняются валидаторы.

    • cardMetadata: ICardMetadata

      Метаинформация по типам файлов и заданий.

    • validationResult: IValidationResultBuilder

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

    • validationManager: ICardValidationManager

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

    • externalContextInfo: null | IStorage<unknown> = null

      Информация из внешнего контекста валидации или null, если внешний контекст не указан.

    • cardValidationMode: CardValidationMode = CardValidationMode.Card

      Способ выполнения валидации для карточек и файлов.

    • taskValidationMode: CardValidationMode = CardValidationMode.Task

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

    • createCardMetadataBinderAdapter: null | ((binder: ICardMetadataBinder) => ICardMetadataBinder) = null

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

    • skipFiles: boolean = false

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

    • skipTasks: boolean = false

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

    Returns Promise<void>

existsInType

  • Возвращает признак того, что секция и колонка с заданными идентификаторами существует в указанном типе карточки.

    Returns

    true, если секция и колонка с заданными идентификаторами существует в указанном типе карточки; false в противном случае.

    Parameters

    • cardType: null | CardType

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

    • sectionId: string

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

    • Optional columnId: string

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

    Returns boolean

getObjectName

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

    Returns

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

    Parameters

    • section: ICardMetadataSection

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

    • column: null | ICardMetadataColumn = null

      Колонка, проверку которой осуществляет валидатор или null, если значение не задано.

    Returns string

getRemoveDuplicates

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

    Returns

    Признак того, что не уникальные значения (дубликаты) нужно автоматически удалять.

    Parameters

    • cardTypeValidator: CardTypeValidator

      Объект, содержащий настройки валидатора.

    Returns boolean

tryGetColumn

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

    Returns

    Метаинформация по одной или нескольким физическим колонкам или null, если значение не найдено. Результат содержит mainColumn - основная колонка, проверка которой выполняется (может быть физической или комплексной) и physicalColumns - метаинформация по одной или нескольким физическим колонкам.

    Parameters

    • section: ICardMetadataSection

      Метаинформация по секции, в которой расположена требуемая колонка.

    • columnId: string

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

    • context: ICardValidationContext

      Контекст валидации.

    • validatorName: string

      Имя экземпляра валидатора.

    Returns {
        mainColumn: ICardMetadataColumn;
        physicalColumns: ICardMetadataColumn[];
    } | null

tryGetColumnId

  • Возвращает идентификатор колонки, которая указана в настройках валидатора, или null, если при получении значения произошла ошибка.

    Returns

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

    Parameters

    • cardTypeValidator: CardTypeValidator

      Объект, содержащий настройки валидатора.

    • context: ICardValidationContext

      Контекст валидации.

    • validatorName: string

      Имя экземпляра валидатора.

    • section: ICardMetadataSection

      Секция, которая была указана в настройках валидатора.

    Returns string | null

tryGetOrderColumnId

  • Возвращает идентификатор колонки для сортировки, которая указана в настройках валидатора или null, если колонка не задана.

    Returns

    Идентификатор колонки или null если колонка не задана.

    Parameters

    • cardTypeValidator: CardTypeValidator

      Объект, содержащий настройки валидатора.

    Returns string | null

tryGetParentSectionAndColumnId

  • Возвращает идентификаторы родительской секции и колонки, которые указаны в настройках валидатора. В случае, если какие-либо настройки не указаны или равны null, то возвращается null.

    Returns

    Идентификаторы родительской секции и колонки, которые указаны в настройках валидатора или null, если настройки не заданы.

    Parameters

    • cardTypeValidator: CardTypeValidator

      Объект, содержащий настройки валидатора.

    Returns {
        columnId: string;
        sectionId: string;
    } | null

tryGetSection

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

    Returns

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

    Parameters

    • sectionId: string

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

    • context: ICardValidationContext

      Контекст валидации.

    • validatorName: string

      Имя экземпляра валидатора.

    Returns ICardMetadataSection | null

tryGetSectionId

  • Возвращает идентификатор секции, которая указана в настройках валидатора или null, если при получении значения произошла ошибка.

    Returns

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

    Parameters

    • cardTypeValidator: CardTypeValidator

      Объект, содержащий настройки валидатора.

    • context: ICardValidationContext

      Контекст валидации.

    • validatorName: string

      Имя экземпляра валидатора.

    Returns string | null

Generated using TypeDoc