Package org.odpi.openmetadata.accessservices.discoveryengine.client

Class DiscoveryAnalysisReportClient

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.DiscoveryAnalysisReportStore

org.odpi.openmetadata.accessservices.discoveryengine.client.DiscoveryAnalysisReportClient

public class DiscoveryAnalysisReportClient
extends DiscoveryAnalysisReportStore

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.DiscoveryAnalysisReportStore

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

Constructor Summary

Constructors

Constructor	Description
DiscoveryAnalysisReportClient(String userId, DiscoveryRequestStatus discoveryRequestStatus, String assetGUID, Map<String,String> analysisParameters, String firstAnalysisStepName, String reportQualifiedName, String reportDisplayName, String reportDescription, String discoveryEngineGUID, String discoveryServiceGUID, DiscoveryEngineClient discoveryEngineClient)	Constructor for this client

Method Summary

Modifier and Type	Method	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.DiscoveryAnalysisReportStore

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 Details

DiscoveryAnalysisReportClient

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

Constructor for this client

Parameters:

userId - calling user

discoveryRequestStatus - current status

assetGUID - linked asset

analysisParameters - parameters that configured the analysis

firstAnalysisStepName - name of the first analysis step performed by the discovery service

reportQualifiedName - qualified name of report

reportDisplayName - display name of report

reportDescription - description of report

discoveryEngineGUID - hosting discovery engine

discoveryServiceGUID - executing discovery service

discoveryEngineClient - calling engine client

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.

Method Details

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 DiscoveryAnalysisReportStore

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 DiscoveryAnalysisReportStore

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.