Package org.gbif.api.vocabulary

Interface InterpretationRemark

All Known Implementing Classes:

NameUsageIssue, OccurrenceIssue

public interface InterpretationRemark

Represents a remark flagged during the interpretation phase. IMPORTANT: Make sure no name clashes in case new implementation were added.

Method Summary

Modifier and Type	Method	Description
String	getId()	Returns the identifier of the InterpretationRemark.
Set<Term>	getRelatedTerms()	Set containing the Term considered to flag this remark.
InterpretationRemarkSeverity	getSeverity()	Returns the default severity of this InterpretationRemark.
boolean	isDeprecated()	Checks if the InterpretationRemark is deprecated or not.

Method Details

getId

String getId()

Returns the identifier of the InterpretationRemark. This is normally implemented to return the result of Enum.name(). Potential name clashes are detected by unit tests.

Returns:

identifier of the InterpretationRemark. Never null.

getRelatedTerms

Set<Term> getRelatedTerms()

Set containing the Term considered to flag this remark.

Returns:

Set of Term or empty Set. Never null.

getSeverity

InterpretationRemarkSeverity getSeverity()

Returns the default severity of this InterpretationRemark. Severity can be relative to the context and profile. This InterpretationRemarkSeverity should be seen as the default severity in the general context of interpretation.

Returns:

default severity of this InterpretationRemark. Never null.

isDeprecated

boolean isDeprecated()

Checks if the InterpretationRemark is deprecated or not.

Returns:

true if the InterpretationRemark is marked with @Deprecated.