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

Interface AssetReviewInterface

All Known Implementing Classes:

AssetOwner, AvroFileAssetOwner, CSVFileAssetOwner, FileSystemAssetOwner, ValidValuesAssetOwner

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

Method Detail

getAssetsByName

java.util.List<AssetElement> getAssetsByName(java.lang.String userId,
                                             java.lang.String name,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             PropertyServerException,
                                             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:

InvalidParameterException - the name is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

findAssets

java.util.List<AssetElement> findAssets(java.lang.String userId,
                                        java.lang.String searchString,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        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:

InvalidParameterException - the searchString is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

getAssetSummary

AssetElement getAssetSummary(java.lang.String userId,
                             java.lang.String assetGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Return the basic attributes of an asset.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset

Returns:

basic asset properties

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.

getAssetProperties

AssetUniverse getAssetProperties(java.lang.String userId,
                                 java.lang.String assetGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 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:

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.

getConnectorToAsset

Connector getConnectorToAsset(java.lang.String userId,
                              java.lang.String assetGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              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:

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.

getDiscoveryAnalysisReports

java.util.List<DiscoveryAnalysisReport> getDiscoveryAnalysisReports(java.lang.String userId,
                                                                    java.lang.String assetGUID,
                                                                    int startingFrom,
                                                                    int maximumResults)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    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:

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.

getTypesOfAnnotation

java.util.List<java.lang.String> getTypesOfAnnotation(java.lang.String userId)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Return the annotation subtype names.

Parameters:

userId - calling user

Returns:

list of type names that are subtypes of annotation

Throws:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getTypesOfAnnotationWithDescriptions

java.util.Map<java.lang.String,java.lang.String> getTypesOfAnnotationWithDescriptions(java.lang.String userId)
                                                                                     throws InvalidParameterException,
                                                                                            UserNotAuthorizedException,
                                                                                            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:

InvalidParameterException - full path or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getDiscoveryReportAnnotations

java.util.List<Annotation> getDiscoveryReportAnnotations(java.lang.String userId,
                                                         java.lang.String discoveryReportGUID,
                                                         AnnotationStatus annotationStatus,
                                                         int startingFrom,
                                                         int maximumResults)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         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:

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

java.util.List<Annotation> getExtendedAnnotations(java.lang.String userId,
                                                  java.lang.String annotationGUID,
                                                  AnnotationStatus annotationStatus,
                                                  int startingFrom,
                                                  int maximumResults)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  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:

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.