org.neo4j.graphdb

Interface Notification

public interface Notification

Representation for notifications found when executing a query. A notification can be visualized in a client pinpointing problems or other information about the query.

Method Summary

Modifier and Type	Method and Description
String	getCode() Returns a notification code for the discovered issue.
String	getDescription() Returns a longer description of the notification.
InputPosition	getPosition() The position in the query where this notification points to.
SeverityLevel	getSeverity() Returns the severity level of this notification.
String	getTitle() Returns a short summary of the notification.

Method Detail

getCode

String getCode()

Returns a notification code for the discovered issue.

Returns:

the notification code

getTitle

String getTitle()

Returns a short summary of the notification.

Returns:

the title of the notification.

getDescription

String getDescription()

Returns a longer description of the notification.

Returns:

the description of the notification.

getSeverity

SeverityLevel getSeverity()

Returns the severity level of this notification.

Returns:

the severity level of the notification.

getPosition

InputPosition getPosition()

The position in the query where this notification points to. Not all notifications have a unique position to point to and should in that case return InputPosition.empty

Returns:

the position in the query where the issue was found, or InputPosition.empty if no position is associated with this notification.