Package org.odpi.openmetadata.accessservices.assetowner.api

Interface AssetReviewInterface

public interface AssetReviewInterface
The AssetReviewInterface is used by the asset owner to review the state of the asset including any quality and usage metrics associated with the asset.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<AssetElement>
    findAssets(String userId, String searchString, int startFrom, int pageSize)
    Return a list of assets with the requested search string in their name, qualified name or description.
    org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse
    getAssetProperties(String userId, String assetGUID)
    Return everything that is known about the asset
    List<AssetElement>
    getAssetsByName(String userId, String name, int startFrom, int pageSize)
    Return a list of assets with the requested name.
    AssetElement
    getAssetSummary(String userId, String assetGUID)
    Return the basic attributes of an asset.
    org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorToAsset(String userId, String assetGUID)
    Return a connector for the asset to enable the calling user to access the content.
    List<org.odpi.openmetadata.frameworks.discovery.properties.DiscoveryAnalysisReport>
    getDiscoveryAnalysisReports(String userId, String assetGUID, int startingFrom, int maximumResults)
    Return the discovery analysis reports about the asset.
    List<org.odpi.openmetadata.frameworks.discovery.properties.Annotation>
    getDiscoveryReportAnnotations(String userId, String discoveryReportGUID, org.odpi.openmetadata.frameworks.discovery.properties.AnnotationStatus annotationStatus, int startingFrom, int maximumResults)
    Return the annotations linked directly to the report.
    List<org.odpi.openmetadata.frameworks.discovery.properties.Annotation>
    getExtendedAnnotations(String userId, String annotationGUID, org.odpi.openmetadata.frameworks.discovery.properties.AnnotationStatus annotationStatus, int startingFrom, int maximumResults)
    Return any annotations attached to this annotation.
    List<String>
    getTypesOfAnnotation(String userId)
    Return the annotation subtype names.
    Map<String,String>
    getTypesOfAnnotationWithDescriptions(String userId)
    Return the annotation subtype names mapped to their descriptions.

  • Method Details

    • getAssetsByName

      List<AssetElement> getAssetsByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return a list of assets with the requested name.
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      list of unique identifiers of assets with matching name.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the name is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem access in the property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user does not have access to the properties

    • findAssets

      List<AssetElement> findAssets(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Return a list of assets with the requested search string in their name, qualified name or description.
      Parameters:
      userId - calling user
      searchString - string to search for in text
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      list of assets that match the search string.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the searchString is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem access in the property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user does not have access to the properties

    • getAssetSummary

      AssetElement getAssetSummary(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the basic attributes of an asset.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      Returns:
      basic asset properties
      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.

    • getAssetProperties

      org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse getAssetProperties(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return everything that is known about the asset
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      Returns:
      asset properties with links to other attached content
      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.

    • getConnectorToAsset

      org.odpi.openmetadata.frameworks.connectors.Connector getConnectorToAsset(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return a connector for the asset to enable the calling user to access the content.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      Returns:
      connector object
      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.

    • getDiscoveryAnalysisReports

      List<org.odpi.openmetadata.frameworks.discovery.properties.DiscoveryAnalysisReport> getDiscoveryAnalysisReports(String userId, String assetGUID, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the discovery analysis reports about the asset.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset
      startingFrom - position in the list (used when there are so many reports that paging is needed
      maximumResults - 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.

    • getTypesOfAnnotation

      List<String> getTypesOfAnnotation(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the annotation subtype names.
      Parameters:
      userId - calling user
      Returns:
      list of type names that are subtypes of annotation
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getTypesOfAnnotationWithDescriptions

      Map<String,String> getTypesOfAnnotationWithDescriptions(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the annotation subtype names mapped to their descriptions.
      Parameters:
      userId - calling user
      Returns:
      map of type names that are subtypes of annotation to their descriptions
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - full path or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getDiscoveryReportAnnotations

      List<org.odpi.openmetadata.frameworks.discovery.properties.Annotation> getDiscoveryReportAnnotations(String userId, String discoveryReportGUID, org.odpi.openmetadata.frameworks.discovery.properties.AnnotationStatus annotationStatus, int startingFrom, int maximumResults) 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
      discoveryReportGUID - identifier of the discovery request.
      annotationStatus - status of the desired annotations - null means all statuses.
      startingFrom - initial position in the stored list.
      maximumResults - 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.discovery.properties.Annotation> getExtendedAnnotations(String userId, String annotationGUID, org.odpi.openmetadata.frameworks.discovery.properties.AnnotationStatus annotationStatus, int startingFrom, int maximumResults) 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
      annotationStatus - status of the desired annotations - null means all statuses.
      startingFrom - starting position in the list
      maximumResults - 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.