Package com.aquima.interactions.composer.report

Class ReportingFieldValidationDS

java.lang.Object

com.aquima.interactions.foundation.report.ReportingDS

com.aquima.interactions.composer.report.ReportingFieldValidationDS

All Implemented Interfaces:

IFieldValidationDS, IReportingDS

public class ReportingFieldValidationDS
extends ReportingDS
implements IFieldValidationDS

IFieldValidationDS implementation that adds error reporting.

Author:

r.fleuren

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReportingFieldValidationDS(IInitializationReport report, IFieldValidationDS datasource)

Method Summary

Modifier and Type	Method	Description
String	getCondition()	This method returns the condition that should be evaluated to determine if the validation should be active.
IMultilingualText	getMessage()	This method returns the text that should be shown when a value does not pass the validation.
String	getType()	this method return the name of the validator type.
boolean	isBlocking()	This method returns a boolean indicating if the validation is blocking (or a warning).
boolean	isEssential()	This method returns a boolean indicating if the validation may be considered a fatal error, and further validation of the value is not needed.
void	iterateParameters(IFieldValidationParameterVisitor visitor)	This method returns a map containing parameters for the validator.

Methods inherited from class com.aquima.interactions.foundation.report.ReportingDS

addError, addMessage, getCategory, getReport

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

addMessage

Constructor Details

ReportingFieldValidationDS

protected ReportingFieldValidationDS(IInitializationReport report,
 IFieldValidationDS datasource)

Method Details

getType

public String getType()

Description copied from interface: IFieldValidationDS

this method return the name of the validator type.

Specified by:

getType in interface IFieldValidationDS

Returns:

the name of the validator type.

isBlocking

public boolean isBlocking()

Description copied from interface: IFieldValidationDS

This method returns a boolean indicating if the validation is blocking (or a warning).

Specified by:

isBlocking in interface IFieldValidationDS

Returns:

boolean indicating if the validation is blocking.

isEssential

public boolean isEssential()

Description copied from interface: IFieldValidationDS

This method returns a boolean indicating if the validation may be considered a fatal error, and further validation of the value is not needed.

Specified by:

isEssential in interface IFieldValidationDS

Returns:

Boolean indicating that the validation is essential and must succeed for any further validation to be useful.

getMessage

public IMultilingualText getMessage()

Description copied from interface: IFieldValidationDS

This method returns the text that should be shown when a value does not pass the validation. The text may contain TSL, but the message will be expanded before the (invalid) value is evaluated.

Specified by:

getMessage in interface IFieldValidationDS

Returns:

text that should be shown when a value does not pass the validation.

getCondition

public String getCondition()

Description copied from interface: IFieldValidationDS

This method returns the condition that should be evaluated to determine if the validation should be active.

Specified by:

getCondition in interface IFieldValidationDS

Returns:

the condition that should be evaluated to determine if the validation should be active.

iterateParameters

public void iterateParameters(IFieldValidationParameterVisitor visitor)

Description copied from interface: IFieldValidationDS

This method returns a map containing parameters for the validator. If the validator does not require any parameters.

Specified by:

iterateParameters in interface IFieldValidationDS

Parameters:

visitor - the visitor which accepts the parameter information