Package com.orchestranetworks.service
Interface ValidationReportItem
public interface ValidationReportItem
Represents an element of a validation report.
A validation item holds a user message, has a severity (usually an error) and has a subject that specifies with which entity (or entities) the message is associated.
-
Method Summary
Modifier and TypeMethodDescriptionReturns the blocking policy associated with this item.getFacet()
Returns the facet that is associated with this item,null
if no facet is associated with this item.Returns a user-friendly message.Returns the severity of this item, which is the severity of the user message.Returns the object that is associated with this item,null
if no subject is associated with this item.Returns the dataset or record object associated with this item,null
if this item is not associated with a node in a dataset or record.Returns the table object associated with this item,null
if this item is not associated with a table.boolean
isError()
Returnstrue
if this item is an error.boolean
isFatal()
Returnstrue
if this item is a "fatal error".boolean
isInfo()
Returnstrue
if this item is an informational message.boolean
isOfSeverity
(Severity aSeverity) Returnstrue
if this item is of the specified severity.boolean
Returnstrue
if this item is related to the maximum number of validation messages to consider per constraint when performing a validation.boolean
Returnstrue
if this item is a warning.
-
Method Details
-
getMessage
UserMessage getMessage()Returns a user-friendly message. -
getSubject
ValidationReportItemSubject getSubject()Returns the object that is associated with this item,null
if no subject is associated with this item. -
getSubjectForAdaptation
ValidationReportItemSubjectForAdaptation getSubjectForAdaptation()Returns the dataset or record object associated with this item,null
if this item is not associated with a node in a dataset or record.- See Also:
-
getSubjectForTable
ValidationReportItemSubjectForTable getSubjectForTable()Returns the table object associated with this item,null
if this item is not associated with a table.- See Also:
-
getFacet
SchemaFacet getFacet()Returns the facet that is associated with this item,null
if no facet is associated with this item.- Since:
- 6.0.0
- See Also:
-
getSeverity
Severity getSeverity()Returns the severity of this item, which is the severity of the user message.- See Also:
-
isFatal
boolean isFatal()Returnstrue
if this item is a "fatal error". -
isError
boolean isError()Returnstrue
if this item is an error. -
isWarning
boolean isWarning()Returnstrue
if this item is a warning. -
isInfo
boolean isInfo()Returnstrue
if this item is an informational message. -
isOfSeverity
Returnstrue
if this item is of the specified severity. -
isValidationMessageThresholdItem
boolean isValidationMessageThresholdItem()Returnstrue
if this item is related to the maximum number of validation messages to consider per constraint when performing a validation. That is, iftrue
this item indicates that the maximum number of validation messages has been reached by a constraint.- Since:
- 5.9.0
- See Also:
-
getBlocksCommit
SchemaFacetBlocksCommit getBlocksCommit()Returns the blocking policy associated with this item.When this item is not related to a facet then it returns
SchemaFacetBlocksCommit.ON_INSERT_UPDATE_DELETE
if the severity of this item isSeverity.FATAL
otherwise it returnsSchemaFacetBlocksCommit.NEVER
for other severities.If the associated facet does not define a blocking policy, then a default one is returned according to the default validation policy of EBX®. That is, this method returns:
-
SchemaFacetBlocksCommit.ON_INSERT_UPDATE_DELETE
if the severity of this item isSeverity.FATAL
. -
SchemaFacetBlocksCommit.USER_SUBMIT_CHECK_MODIFIED_VALUES
if the severity of this item isSeverity.ERROR
or if this item is related to a mandatory field that defines the propertyosd:checkNullInput=true
. -
SchemaFacetBlocksCommit.NEVER
if the severity of this item isSeverity.WARNING
orSeverity.INFO
, or if this item is related to a mandatory field that does not define the propertyosd:checkNullInput=true
.
- Since:
- 6.0.0
- See Also:
-
-