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

Interface SurveyReportInterface

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<org.odpi.openmetadata.frameworks.surveyaction.properties.Annotation>
    getExtendedAnnotations(String userId, String annotationGUID, int startFrom, int pageSize)
    Return any annotations attached to this annotation.
    List<org.odpi.openmetadata.frameworks.surveyaction.properties.Annotation>
    getSurveyReportAnnotations(String userId, String reportGUID, int startFrom, int pageSize)
    Return the annotations linked directly to the report.
    List<org.odpi.openmetadata.frameworks.surveyaction.properties.SurveyReport>
    getSurveyReports(String userId, String assetGUID, int startFrom, int pageSize)
    Return the survey reports linked to the asset.

  • Method Details

    • getSurveyReports

      List<org.odpi.openmetadata.frameworks.surveyaction.properties.SurveyReport> getSurveyReports(String userId, String assetGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem that occurred within the property server.

    • getSurveyReportAnnotations

      List<org.odpi.openmetadata.frameworks.surveyaction.properties.Annotation> getSurveyReportAnnotations(String userId, String reportGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem that occurred within the property server.

    • getExtendedAnnotations

      List<org.odpi.openmetadata.frameworks.surveyaction.properties.Annotation> getExtendedAnnotations(String userId, String annotationGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem that occurred within the property server.