Class DiscoveryAnalysisReportStore
java.lang.Object
org.odpi.openmetadata.frameworks.discovery.DiscoveryAnalysisReportStore
- Direct Known Subclasses:
DiscoveryAnalysisReportClient
DiscoveryAnalysisReportStore provides a client to the open metadata repository that manages the content
of the discovery analysis report.
It is part of the DiscoveryAnnotationStore.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturn the locally defined analysis step.Return the creation date for the discovery analysis report that will result from this discovery request.Return the report identifier for this discovery context.Return the current status of the discovery request - this is stored in the report.Return the description for the discovery analysis report that will result from this discovery request.Return the display name of the discovery analysis report that will result from this discovery request.Return the unique name of the discovery analysis report that will result from this discovery request.void
setAnalysisStep
(String analysisStep) Set up the name of the current analysis step.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.void
setReportDescription
(String reportDescription) Set up the description for the discovery analysis report that will result from this discovery request.void
setReportDisplayName
(String reportName) Set up the display name of the discovery analysis report that will result from this discovery request.void
setReportQualifiedName
(String reportName) Set up the unique name of the discovery analysis report that will result from this discovery request.
-
Field Details
-
userId
-
discoveryReportGUID
-
discoveryRequestStatus
-
reportQualifiedName
-
reportDisplayName
-
reportDescription
-
creationDate
-
analysisStep
-
-
Constructor Details
-
DiscoveryAnalysisReportStore
protected DiscoveryAnalysisReportStore()Default constructor
-
-
Method Details
-
getDiscoveryReportGUID
Return the report identifier for this discovery context. Any new annotations added to tis discovery context will be linked to this report.- Returns:
- unique identifier (guid) of the new discovery report.
-
getDiscoveryRequestStatus
public DiscoveryRequestStatus getDiscoveryRequestStatus() throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionReturn the current status of the discovery request - this is stored in the report.- Returns:
- current status of the discovery request/report
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user id not authorized to issue this requestPropertyServerException
- 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.- Parameters:
discoveryRequestStatus
- new status of the discovery request/report- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user id not authorized to issue this requestPropertyServerException
- there was a problem retrieving annotations from the annotation store.
-
getAnalysisStep
Return the locally defined analysis step. This value is used in annotations generated in this phase.- Returns:
- name of analysis step
-
setAnalysisStep
Set up the name of the current analysis step.- Parameters:
analysisStep
- name
-
getReportQualifiedName
Return the unique name of the discovery analysis report that will result from this discovery request.- Returns:
- String report name
-
setReportQualifiedName
Set up the unique name of the discovery analysis report that will result from this discovery request. The discovery engine will set up a default fully-qualified name. This method enables it to be over-ridden.- Parameters:
reportName
- String report name
-
getReportDisplayName
Return the display name of the discovery analysis report that will result from this discovery request.- Returns:
- String report name
-
setReportDisplayName
Set up the display name of the discovery analysis report that will result from this discovery request. The default name is null.- Parameters:
reportName
- String report name
-
getReportDescription
Return the description for the discovery analysis report that will result from this discovery request. The default value is null.- Returns:
- String report description
-
setReportDescription
Set up the description for the discovery analysis report that will result from this discovery request.- Parameters:
reportDescription
- String report description
-
getCreationDate
Return the creation date for the discovery analysis report that will result from this discovery request.- Returns:
- Date that the report was created.
-