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 TypeMethodDescriptionfindAssets
(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.getAssetProperties
(String userId, String assetGUID) Return everything that is known about the assetgetAssetsByName
(String userId, String name, int startFrom, int pageSize) Return a list of assets with the requested name.getAssetSummary
(String userId, String assetGUID) Return the basic attributes of an asset.getConnectorToAsset
(String userId, String assetGUID) Return a connector for the asset to enable the calling user to access the content.getDiscoveryAnalysisReports
(String userId, String assetGUID, int startingFrom, int maximumResults) Return the discovery analysis reports about the asset.getDiscoveryReportAnnotations
(String userId, String discoveryReportGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults) Return the annotations linked directly to the report.getExtendedAnnotations
(String userId, String annotationGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults) Return any annotations attached to this annotation.getTypesOfAnnotation
(String userId) Return the annotation subtype names.Return the annotation subtype names mapped to their descriptions.
-
Method Details
-
getAssetsByName
List<AssetElement> getAssetsByName(String userId, String name, int startFrom, int pageSize) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Return a list of assets with the requested name.- Parameters:
userId
- calling username
- name to search forstartFrom
- 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 invalidPropertyServerException
- there is a problem access in the property serverUserNotAuthorizedException
- the user does not have access to the properties
-
findAssets
List<AssetElement> findAssets(String userId, 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 usersearchString
- string to search for in textstartFrom
- 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 invalidPropertyServerException
- there is a problem access in the property serverUserNotAuthorizedException
- the user does not have access to the properties
-
getAssetSummary
AssetElement getAssetSummary(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return the basic attributes of an asset.- Parameters:
userId
- calling userassetGUID
- 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(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return everything that is known about the asset- Parameters:
userId
- calling userassetGUID
- 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(String userId, String assetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return a connector for the asset to enable the calling user to access the content.- Parameters:
userId
- calling userassetGUID
- 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
List<DiscoveryAnalysisReport> getDiscoveryAnalysisReports(String userId, String assetGUID, int startingFrom, int maximumResults) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return the discovery analysis reports about the asset.- Parameters:
userId
- calling userassetGUID
- unique identifier of the assetstartingFrom
- position in the list (used when there are so many reports that paging is neededmaximumResults
- 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
List<String> getTypesOfAnnotation(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 nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getTypesOfAnnotationWithDescriptions
Map<String,String> getTypesOfAnnotationWithDescriptions(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 nullPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getDiscoveryReportAnnotations
List<Annotation> getDiscoveryReportAnnotations(String userId, 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 userdiscoveryReportGUID
- 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
List<Annotation> getExtendedAnnotations(String userId, String annotationGUID, AnnotationStatus annotationStatus, int startingFrom, int maximumResults) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return any annotations attached to this annotation.- Parameters:
userId
- identifier of calling userannotationGUID
- anchor annotationannotationStatus
- status of the desired annotations - null means all statuses.startingFrom
- starting position in the listmaximumResults
- 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.
-