kform/tech.ostack.kform.validations/ScopedValidation

ScopedValidation

abstract class ScopedValidation<in T, TScope> @JvmOverloads constructor(scopeExternalContextName: String = DEFAULT_SCOPE_EXTERNAL_CONTEXT_NAME) : Validation<T> (source)

A scoped validation is a validation that should only run when the current "validation scope" is allowed by the provided scopes.

The current validation scope is obtained via an external context with a name defaulting to DEFAULT_SCOPE_EXTERNAL_CONTEXT_NAME (which can be overriden during class construction).

Inheritors

ScopedJvmValidation

Constructors

ScopedValidation

@JvmOverloads

constructor(scopeExternalContextName: String = DEFAULT_SCOPE_EXTERNAL_CONTEXT_NAME)

Types

Companion

object Companion

Properties

dependencies

open override val dependencies: Map<String, DependencyInfo>

Dependencies of the validation. Mapping of keys to the paths this validation depends on. Keys can be used within a ValidationContext to access the value of the dependencies.

dependsOnDescendants

open val dependsOnDescendants: Boolean

Whether the form manager should reevaluate this validation whenever a descendant of the value being validated changes. This is false by default.

externalContextDependencies

open override val externalContextDependencies: Set<String>

Set of external context dependencies of the validation.

scopes

abstract val scopes: ValidationScopes<TScope>

Validation scopes of this validation.

Functions

scopedValidate

abstract fun ValidationContext.scopedValidate(): Flow<ValidationIssue>

Runs the scoped validation (when the current "validation scope" is allowed by the provided scopes) within a ValidationContext containing the value being validated and the value of all declared dependencies. Returns a flow over all found issues.

toString

open override fun toString(): String

validate

override fun ValidationContext.validate(): Flow<ValidationIssue>

Runs the validation within a ValidationContext containing the value being validated and the value of all declared dependencies. Returns a flow over all found issues.