Package org.odpi.openmetadata.frameworks.surveyaction.controls

Interface AnnotationType

All Known Implementing Classes:

SurveyDatabaseAnnotationType, SurveyFileAnnotationType, SurveyFolderAnnotationType, SurveyResourceManagerAnnotationType

public interface AnnotationType

The AnnotationType interface is implemented by an enum that describes the annotation types produced by a survey action service. This interface is a template for survey writers to use to take advantage of common functions in the SurveyActionService base class.

Method Summary

Modifier and Type	Method	Description
String	getAnalysisStep()	Return the analysis step that produces this type of annotation.
String	getExplanation()	Return the description of the processing that produces the annotation type.
String	getExpression()	Return the expression used in the annotation type processing.
String	getName()	Return the name of the annotation type.
String	getOpenMetadataTypeName()	Return the name of the open metadata type used for this type of annotation.
String	getSummary()	Return the short description of the annotation type.

Method Details

getName

String getName()

Return the name of the annotation type.

Returns:

string name

getAnalysisStep

String getAnalysisStep()

Return the analysis step that produces this type of annotation.

Returns:

analysis step name

getOpenMetadataTypeName

String getOpenMetadataTypeName()

Return the name of the open metadata type used for this type of annotation.

Returns:

type name

getSummary

String getSummary()

Return the short description of the annotation type.

Returns:

text

getExplanation

String getExplanation()

Return the description of the processing that produces the annotation type.

Returns:

text

getExpression

String getExpression()

Return the expression used in the annotation type processing.

Returns:

string