kform/tech.ostack.kform.validations/ValidationScopes

ValidationScopes

sealed class ValidationScopes<T> : Set<T?> (source)

Validation scopes under which a validation is allowed to run. These can be specified via an allow list with OneOf or via a deny list with NotOneOf.

Note that, if no scope is provided as an external context during runtime, the default scope will be null. In this scenario, for the allow list case, unless null is explicitely passed to OneOf, the validation will never run; similarly, for the deny list case, unless null is explicitely passed to NotOneOf, the validation will always run.

Inheritors

OneOf

NotOneOf

Types

NotOneOf

class NotOneOf<T>(scopes: Iterable<T?>) : ValidationScopes<T>

Deny list of scopes under which the validation should not run.

OneOf

class OneOf<T>(scopes: Iterable<T?>) : ValidationScopes<T>

Allow list of scopes under which the validation should run.

Properties

size

open override val size: Int

Functions

allows

abstract fun allows(scope: T?): Boolean

Whether the validation scopes allow the provided scope.

contains

open operator override fun contains(element: T?): Boolean

containsAll

open override fun containsAll(elements: Collection<T?>): Boolean

containsErrors

fun Iterable<LocatedValidationIssue>.containsErrors(): Boolean

Returns whether a collection of located validation issues contains any errors.

containsIssues

fun Iterable<LocatedValidationIssue>.containsIssues(): Boolean

Returns whether a collection of located validation issues contains any issues at all.

containsNoErrors

fun Iterable<LocatedValidationIssue>.containsNoErrors(): Boolean

Returns whether a collection of located validation issues contains no errors.

containsNoIssues

fun Iterable<LocatedValidationIssue>.containsNoIssues(): Boolean

Returns whether a collection of located validation issues contains no issues at all.

containsNoWarnings

fun Iterable<LocatedValidationIssue>.containsNoWarnings(): Boolean

Returns whether a collection of located validation issues contains no warnings.

containsWarnings

fun Iterable<LocatedValidationIssue>.containsWarnings(): Boolean

Returns whether a collection of located validation issues contains any warnings.

convertTableRowIndicesToIds

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

Utility function which converts the paths of an iterable of LocatedValidationIssues 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).

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Iterator<T?>

toTable

fun <T> Collection<T>.toTable(): Table<T>

Creates a table from a Collection, using auto-generated identifiers.

fun <T> Iterable<T>.toTable(): Table<T>

Creates a table from an Iterable, using auto-generated identifiers.