Package org.odpi.openmetadata.accessservices.stewardshipaction.api

Interface SurveyReportInterface

All Known Implementing Classes:

StewardshipAction

public interface SurveyReportInterface

The SurveyReportInterface is used by the steward to review the survey reports associated with an asset.

Method Summary

Modifier and Type	Method	Description
List<Annotation>	getExtendedAnnotations(String userId, String annotationGUID, int startFrom, int pageSize)	Return any annotations attached to this annotation.
List<Annotation>	getSurveyReportAnnotations(String userId, String reportGUID, int startFrom, int pageSize)	Return the annotations linked directly to the report.
List<SurveyReport>	getSurveyReports(String userId, String assetGUID, int startFrom, int pageSize)	Return the survey reports linked to the asset.

Method Details

getSurveyReports

List<SurveyReport> getSurveyReports(String userId,
 String assetGUID,
 int startFrom,
 int pageSize)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the survey reports linked to the asset.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset

startFrom - position in the list (used when there are so many reports that paging is needed)

pageSize - maximum number of elements to return an this call

Returns:

list of discovery analysis reports

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getSurveyReportAnnotations

List<Annotation> getSurveyReportAnnotations(String userId,
 String reportGUID,
 int startFrom,
 int pageSize)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the annotations linked directly to the report.

Parameters:

userId - identifier of calling user

reportGUID - identifier of the discovery request.

startFrom - initial position in the stored list.

pageSize - maximum number of definitions to return on this call.

Returns:

list of annotations

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.

getExtendedAnnotations

List<Annotation> getExtendedAnnotations(String userId,
 String annotationGUID,
 int startFrom,
 int pageSize)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return any annotations attached to this annotation.

Parameters:

userId - identifier of calling user

annotationGUID - anchor annotation

startFrom - starting position in the list

pageSize - maximum number of annotations that can be returned.

Returns:

list of Annotation objects

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem that occurred within the property server.