kform/tech.ostack.kform/LocatedValidationError

LocatedValidationError

@Serializable

@SerialName(value = "error")

class LocatedValidationError @JvmOverloads constructor(val path: AbsolutePath, val code: String, val dependencies: Set<AbsolutePath> = emptySet(), val dependsOnDescendants: Boolean = false, val externalContextDependencies: Set<String> = emptySet(), val data: ValidationIssueData = emptyMap()) : LocatedValidationIssue(source)

Validation error emitted by a form validator or manager containing location information.

Constructors

LocatedValidationError

@JvmOverloads

constructor(path: Path, code: String, dependencies: Iterable<Path> = emptySet(), dependsOnDescendants: Boolean = false, externalContextDependencies: Iterable<String> = emptySet(), data: ValidationIssueData = emptyMap())

@JvmOverloads

constructor(path: String, code: String, dependencies: Iterable<String> = emptySet(), dependsOnDescendants: Boolean = false, externalContextDependencies: Iterable<String> = emptySet(), data: ValidationIssueData = emptyMap())

@JvmOverloads

constructor(path: AbsolutePath, code: String, dependencies: Set<AbsolutePath> = emptySet(), dependsOnDescendants: Boolean = false, externalContextDependencies: Set<String> = emptySet(), data: ValidationIssueData = emptyMap())

Properties

code

open override val code: String

Code representing the issue.

data

open override val data: ValidationIssueData

Additional issue data. This additional data can be used, for example, to help write a user-friendly message associated with the issue.

dependencies

open override val dependencies: Set<AbsolutePath>

Paths of values that the validation that produced this issue depends on.

dependsOnDescendants

open override val dependsOnDescendants: Boolean = false

Whether the validation that produced this issue depends on the descendants of the validated value.

externalContextDependencies

open override val externalContextDependencies: Set<String>

External contexts that the validation that produced this issue depends on.

path

open override val path: AbsolutePath

Path of the value containing the issue.

severity

val severity: ValidationIssueSeverity

Severity of the located validation issue.

Functions

contains

fun contains(issue: LocatedValidationIssue): Boolean

Whether this located validation issue "contains" issue.

convertTableRowIndicesToIds

suspend fun <T> LocatedValidationIssue.convertTableRowIndicesToIds(formSchema: Schema<T>, formValue: T): LocatedValidationIssue

Utility function which converts the paths of a LocatedValidationIssue where table rows are indexed by their index into paths where said rows are indexed by their id in the corresponding table within the provided form value formValue (with schema formSchema).

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String