Package ddf.catalog.validation.violation

Interface QueryValidationViolation

public interface QueryValidationViolation

Describes a violation of a constraint on query.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	QueryValidationViolation.Severity	Describes the severity of a validation violation.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getExtraData()	Returns supplemental information about the violation.
String	getMessage()	Returns a message describing the violation.
QueryValidationViolation.Severity	getSeverity()	Returns the severity of the violation.

Method Details

getSeverity

QueryValidationViolation.Severity getSeverity()

Returns the severity of the violation. Cannot return null.

Returns:

the severity

getMessage

String getMessage()

Returns a message describing the violation. Cannot return null.

Returns:

the message

getExtraData

Map<String,Object> getExtraData()

Returns supplemental information about the violation. This is structured data that is more easily parsable than the message. Cannot return null.

Returns:

a map of supplemental information