org.odpi.openmetadata.accessservices.discoveryengine.client

Class DiscoveryReportClient

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.DiscoveryReport

org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryReportClient

public class DiscoveryReportClient
extends DiscoveryReport

DiscoveryReportClient is the client interface for managing the values in a Discovery Analysis Report using the Discovery Engine OMAS services.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.discovery.DiscoveryReport

analysisStep, creationDate, discoveryReportGUID, discoveryRequestStatus, reportDescription, reportDisplayName, reportQualifiedName, userId

Constructor Summary

Constructors

Constructor and Description
DiscoveryReportClient(String userId, DiscoveryRequestStatus discoveryRequestStatus, String assetGUID, Map<String,String> analysisParameters, String reportQualifiedName, String reportDisplayName, String reportDescription, String discoveryEngineGUID, String discoveryServiceGUID, DiscoveryEngineClient discoveryEngineClient)

Method Summary

Modifier and Type	Method and Description
DiscoveryRequestStatus	getDiscoveryRequestStatus() Return the current status of the discovery request - this is stored in the report.
void	setDiscoveryRequestStatus(DiscoveryRequestStatus discoveryRequestStatus) Set up the current status of the discovery request - this is stored in the report so it can be monitored by the originator of the request.

Methods inherited from class org.odpi.openmetadata.frameworks.discovery.DiscoveryReport

getAnalysisStep, getCreationDate, getDiscoveryReportGUID, getReportDescription, getReportDisplayName, getReportQualifiedName, setAnalysisStep, setReportDescription, setReportDisplayName, setReportQualifiedName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiscoveryReportClient

public DiscoveryReportClient(String userId,
                             DiscoveryRequestStatus discoveryRequestStatus,
                             String assetGUID,
                             Map<String,String> analysisParameters,
                             String reportQualifiedName,
                             String reportDisplayName,
                             String reportDescription,
                             String discoveryEngineGUID,
                             String discoveryServiceGUID,
                             DiscoveryEngineClient discoveryEngineClient)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

Method Detail

getDiscoveryRequestStatus

public DiscoveryRequestStatus getDiscoveryRequestStatus()
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Return the current status of the discovery request - this is stored in the report.

Overrides:

getDiscoveryRequestStatus in class DiscoveryReport

Returns:

current status of the discovery request/report

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user id not authorized to issue this request

PropertyServerException - there was a problem retrieving annotations from the annotation store.

setDiscoveryRequestStatus

public void setDiscoveryRequestStatus(DiscoveryRequestStatus discoveryRequestStatus)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Set up the current status of the discovery request - this is stored in the report so it can be monitored by the originator of the request.

Overrides:

setDiscoveryRequestStatus in class DiscoveryReport

Parameters:

discoveryRequestStatus - new status of the discovery request/report

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user id not authorized to issue this request

PropertyServerException - there was a problem retrieving annotations from the annotation store.