org.sonar.api.workflow
Interface Review

All Known Subinterfaces:

MutableReview

All Known Implementing Classes:

DefaultReview

@Beta
public interface Review

Since:

3.1

Method Summary

Long	getLine()
String	getMessage()
Map<String,String>	getProperties()
String	getResolution()
Long	getReviewId() This method will probably be removed in order to decrease coupling with database.
String	getRuleKey()
String	getRuleName()
String	getRuleRepositoryKey()
String	getSeverity()
String	getStatus()
boolean	isManual()
boolean	isSwitchedOff()

Method Detail

getReviewId

Long getReviewId()

This method will probably be removed in order to decrease coupling with database.

Returns:

not-null review id (primary key of the table REVIEWS).

getRuleRepositoryKey

String getRuleRepositoryKey()

Returns:

not-null rule repository, for example "checkstyle"

getRuleKey

String getRuleKey()

Returns:

not-null rule key

getRuleName

String getRuleName()

Returns:

not-null rule name, in English.

isSwitchedOff

boolean isSwitchedOff()

getMessage

String getMessage()

getProperties

Map<String,String> getProperties()

Returns:

not-null properties

getStatus

String getStatus()

getResolution

String getResolution()

getSeverity

String getSeverity()

Returns:

not-null severity, from INFO to BLOCKER

getLine

Long getLine()

Returns:

optional line, starting from 1

isManual

boolean isManual()

Returns:

true if the violation has been created by an automated rule engine, false if created by an end-user.