kform/tech.ostack.kform.validations/MaxScale

MaxScale

open class MaxScale @JvmOverloads constructor(val maxScale: Int, val code: String = DEFAULT_CODE, val severity: ValidationIssueSeverity = ValidationIssueSeverity.Error) : Validation<BigDecimal> (source)

Validation that checks that a big decimal value's scale is at most maxScale.

When the scale of the big decimal being validated is greater than maxScale, then an issue is emitted with the provided code (defaults to "scaleOverflow"). This issue contains a scale data property with the scale of the value that was validated and a maxScale data property with the value of maxScale.

Constructors

MaxScale

@JvmOverloads

constructor(maxScale: Int, code: String = DEFAULT_CODE, severity: ValidationIssueSeverity = ValidationIssueSeverity.Error)

Types

Companion

object Companion

Properties

code

val code: String

Issue code to use when the value's scale is greater than maxScale.

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 = false

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.

maxScale

val maxScale: Int

Maximum allowed scale.

schema

protected val ValidationContext.schema: Schema<BigDecimal>

Schema of the value being validated.

severity

val severity: ValidationIssueSeverity

Severity of the issue emitted when the value's scale is greater than maxScale.

value

protected val ValidationContext.value: BigDecimal

Value being validated.

Functions

addDependency

@JvmName(name = "reifiedAddDependency")

protected inline fun <TDependency> addDependency(dependencyKey: String, path: String)

protected fun addDependency(dependencyKey: String, path: String)

@JvmName(name = "reifiedAddDependency")

protected inline fun <TDependency> addDependency(dependencyKey: String, path: Path)

protected fun addDependency(dependencyKey: String, path: Path)

Declares a dependency to path, accessible in the validation's context via key dependencyKey.

addExternalContextDependency

protected fun addExternalContextDependency(externalContextName: String)

Declares an external context dependency to externalContextName.

dependency

protected inline fun <TDependency> dependency(path: String, dependencyKey: String? = null): PropertyDelegateProvider<Validation<BigDecimal>, ReadOnlyProperty<ValidationContext, TDependency>>

protected inline fun <TDependency> dependency(path: Path, dependencyKey: String? = null): PropertyDelegateProvider<Validation<BigDecimal>, ReadOnlyProperty<ValidationContext, TDependency>>

Function used to declare a dependency to a path and delegate access to its value within a ValidationContext.

dependencyOrNull

protected inline fun <TDependency> dependencyOrNull(path: String, dependencyKey: String? = null): PropertyDelegateProvider<Validation<BigDecimal>, ReadOnlyProperty<ValidationContext, TDependency?>>

protected inline fun <TDependency> dependencyOrNull(path: Path, dependencyKey: String? = null): PropertyDelegateProvider<Validation<BigDecimal>, ReadOnlyProperty<ValidationContext, TDependency?>>

Function used to declare a dependency to a path and delegate access to its value within a ValidationContext.

externalContext

protected fun <TContext> externalContext(externalContextName: String? = null): PropertyDelegateProvider<Validation<BigDecimal>, ReadOnlyProperty<ValidationContext, TContext>>

Function used to declare a dependency to an external context and delegate access to its value within a ValidationContext.

externalContextOrNull

protected fun <TContext> externalContextOrNull(externalContextName: String? = null): PropertyDelegateProvider<Validation<BigDecimal>, ReadOnlyProperty<ValidationContext, TContext?>>

Function used to declare a dependency to an external context and delegate access to its value within a ValidationContext.

toString

open override fun toString(): String

validate

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