com.inet.problemfinder.rules

Interface ProblemFinderRule

All Known Implementing Classes:

AbstractRuleElement, AbstractRuleField, AbstractRulePropertyFormula, AbstractRuleReport, AbstractRuleSection

public interface ProblemFinderRule

This Interface defines a ProblemFinderRule that can be called via the ProblemFinder.
A rule checks the report for a certain problem.

See Also:

ProblemFinder

Method Summary

Modifier and Type	Method and Description
default java.util.List<ProblemFinderWarning>	findErrors(Engine engine, java.util.Properties userProperties) Runs this rule and checks the given Engine for Problems
default java.util.List<ProblemFinderWarning>	findErrors(Engine engine) Deprecated. As of i-net Clear Reports 20.10, use findErrors(Engine, Properties) instead
java.lang.String	getRuleLabel() Get the localized label for this rule.

Method Detail

findErrors

default java.util.List<ProblemFinderWarning> findErrors(Engine engine,
                                                        java.util.Properties userProperties)

Runs this rule and checks the given Engine for Problems

Parameters:

engine - The Engine to check.

userProperties - possible prompt values, can be empty if the user has never run the report

Returns:

A list of found problems, can be empty or null if the Check is Canceled.

Since:

i-net Clear Reports 20.10

findErrors

default java.util.List<ProblemFinderWarning> findErrors(Engine engine)

Deprecated. As of i-net Clear Reports 20.10, use findErrors(Engine, Properties) instead

Runs this rule and checks the given Engine for Problems

Parameters:

engine - The Engine to check.

Returns:

A list of found problems, can be empty or null if the Check is Canceled.

Throws:

java.lang.RuntimeException - if you not override one of the methods

Since:

i-net Clear Reports 12.0

getRuleLabel

java.lang.String getRuleLabel()

Get the localized label for this rule. This gives a general description.

Returns:

the localized label.

Since:

i-net Clear Reports 12.0