io.doov.core.dsl.lang

Interface ValidationRule

All Superinterfaces:

DSLBuilder, Readable

All Known Implementing Classes:

DefaultValidationRule

public interface ValidationRule
extends DSLBuilder

Interface for the validation rule that encapsulates the validation algorithm and data.

This class should be used when keeping references to specific rules.

Method Summary

Modifier and Type	Method and Description
default Result	execute() Executes the validation rule on a null model.
Result	executeOn(FieldModel model) Executes the validation rule on the given model.
Result	executeOn(FieldModel model, Context context) Executes the validation rule on the given model.
StepWhen	getStepWhen() Returns the root when node of this rule.
ValidationRule	withShortCircuit(boolean shortCircuit) Returns a validation rule with the given short circuit.

Methods inherited from interface io.doov.core.dsl.lang.DSLBuilder

isUsing, markdown, markdown, metadata, readable, readable

Method Detail

getStepWhen

StepWhen getStepWhen()

Returns the root when node of this rule.

Returns:

the step when

withShortCircuit

ValidationRule withShortCircuit(boolean shortCircuit)

Returns a validation rule with the given short circuit.

Parameters:

shortCircuit - the short circuit

Returns:

the validation rule

execute

default Result execute()

Executes the validation rule on a null model.

Returns:

the result

executeOn

Result executeOn(FieldModel model)

Executes the validation rule on the given model.

Parameters:

model - the model

Returns:

the result

executeOn

Result executeOn(FieldModel model,
                 Context context)

Executes the validation rule on the given model.

Parameters:

model - the model

context - custom context

Returns:

the result