kform/tech.ostack.kform.validations/ScopedAsyncValidation

ScopedAsyncValidation

abstract class ScopedAsyncValidation<in T, TScope> @JvmOverloads constructor(scopeExternalContextName: String = DEFAULT_SCOPE_EXTERNAL_CONTEXT_NAME) : ScopedJvmValidation<T, TScope>

Asynchronous scoped validation more easily implementable from Java.

Constructors

@JvmOverloads

constructor(scopeExternalContextName: String = DEFAULT_SCOPE_EXTERNAL_CONTEXT_NAME)

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 override var dependsOnDescendants: Boolean

Whether the FormManager 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

override val scopes: ValidationScopes<TScope>

Validation scopes of this validation.

Functions

scopedValidate

override 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.

abstract fun scopedValidate(context: ValidationContext, issues: MutableList<ValidationIssue>): CompletionStage<Unit>?

Asynchronous implementation of ValidationContext.scopedValidate returning a completion stage. Validation issues should be added to issues (which is a synchronized list).

scopes

abstract fun scopes(): ValidationScopes<TScope>

Returns the validation scopes of this validation.

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.