Package com.orchestranetworks.service

Interface ValidationReport

public interface ValidationReport

A validation report is composed of validation items, each one characterized by a severity and a user message.

Message threshold property

A threshold property can be set so as to specify the maximum number of messages, for each constraint defined in a data model. It is defined by the property ebx.validation.constraints.messages.threshold (see EBX® main configuration file).

This threshold is taken into account for each constraint of a data model. When the threshold is reached by a constraint and for a severity:

• The validation of the constraint is stopped;
• An error message indicating that the threshold has been reached is added to the validation report.

When set to '0' or a negative value, the threshold is not taken into account. Default threshold is '0'.

See Also:

• ValidationReportItem
• getTooManyMessagesItems()
• hasConstraintsWithTooManyMessages()

Method Summary

Modifier and Type	Method	Description
int	countItemsOfSeverity(Severity aSeverity)	Returns the number of validation items of the severity specified.
ValidationReportItemIterator	getItemsOfSeverity(Severity aSeverity)	Returns the validation items of the severity specified.
ValidationReportItemIterator	getItemsOfSeverityOrMore(Severity aSeverity)	Returns the validation items of the specified severity and higher (more severe).
ValidationReportItemIterator	getTooManyMessagesItems()	Returns the validation items that contain the information about the constraints that have reached the validation message threshold.
boolean	hasConstraintsWithTooManyMessages()	Returns true if the threshold specified in the EBX® main configuration file has been reached on items of the severity error by at least one constraint.
boolean	hasItems()	Returns true if this report has validation items.
boolean	hasItemsOfSeverity(Severity aSeverity)	Returns true if this report has validation items of the severity specified.
boolean	hasItemsOfSeverityOrMore(Severity aSeverity)	Returns true if this report has validation items of the severity specified or higher (more severe).
boolean	hasSkippedValidation()	Returns true if this validation report is empty because the validation of the dataset, table or record didn't wait for the end of a concurrent validation.
boolean	hasTooManyItemsOfSeverity(Severity aSeverity)	Returns true if the threshold specified in the EBX® main configuration file has been reached at least by a constraint for the specified severity.

Method Details

hasItems

boolean hasItems()

Returns true if this report has validation items.

Since:

5.8.0

hasConstraintsWithTooManyMessages

boolean hasConstraintsWithTooManyMessages()

Returns true if the threshold specified in the EBX® main configuration file has been reached on items of the severity error by at least one constraint.

For more information, see Message threshold property and EBX® main configuration file.

Since:

5.8.0

See Also:

• hasTooManyItemsOfSeverity(Severity)
• getTooManyMessagesItems()

hasItemsOfSeverity

boolean hasItemsOfSeverity(Severity aSeverity)

Returns true if this report has validation items of the severity specified.

countItemsOfSeverity

int countItemsOfSeverity(Severity aSeverity)

Returns the number of validation items of the severity specified.

Since:

5.8.0

hasItemsOfSeverityOrMore

boolean hasItemsOfSeverityOrMore(Severity aSeverity)

Returns true if this report has validation items of the severity specified or higher (more severe).

See Also:

• Severity.isEqualOrMoreSevereThan(Severity)

hasTooManyItemsOfSeverity

boolean hasTooManyItemsOfSeverity(Severity aSeverity)

Returns true if the threshold specified in the EBX® main configuration file has been reached at least by a constraint for the specified severity.

For more information, see Message threshold property.

See Also:

• hasConstraintsWithTooManyMessages()
• getTooManyMessagesItems()

getItemsOfSeverity

ValidationReportItemIterator getItemsOfSeverity(Severity aSeverity)

Returns the validation items of the severity specified.

getItemsOfSeverityOrMore

ValidationReportItemIterator getItemsOfSeverityOrMore(Severity aSeverity)

Returns the validation items of the specified severity and higher (more severe).

See Also:

• Severity.isEqualOrMoreSevereThan(Severity)

getTooManyMessagesItems

ValidationReportItemIterator getTooManyMessagesItems()

Returns the validation items that contain the information about the constraints that have reached the validation message threshold.

Since:

5.8.0

See Also:

• hasConstraintsWithTooManyMessages()

hasSkippedValidation

boolean hasSkippedValidation()

Returns true if this validation report is empty because the validation of the dataset, table or record didn't wait for the end of a concurrent validation.

See Also:

• ValidationSpec.RefreshPolicy.NO_WAIT