java.lang.Object
- org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>
- - org.odpi.openmetadata.commonservices.generichandlers.DiscoveryAnalysisReportHandler<B>

```
public class DiscoveryAnalysisReportHandler<B>
extends OpenMetadataAPIGenericHandler<B>
```
DiscoveryAnalysisReportHandler manages the storage and retrieval of metadata relating to discovery analysis reports as defined in the Open Discovery Framework (ODF).

Field Summary
- Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
  auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors
Constructor	Description
`DiscoveryAnalysisReportHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)`	Construct the handler with information needed to work with B objects.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`createDiscoveryAnalysisReport(String userId, String qualifiedName, String displayName, String description, Date creationDate, Map<String,String> analysisParameters, int discoveryRequestStatus, String assetGUID, String discoveryEngineGUID, String discoveryServiceGUID, Map<String,String> additionalProperties, String methodName)`	Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.
`B`	`getDiscoveryAnalysisReport(String userId, String discoveryReportGUID, String methodName)`	Request the discovery report for a discovery request that has completed.
`List<B>`	`getDiscoveryAnalysisReports(String userId, String assetGUID, int startingFrom, int maximumResults, String methodName)`	Return the discovery analysis reports about the asset.
`void`	`updateDiscoveryAnalysisReport(String userId, String discoveryReportGUID, String qualifiedName, String displayName, String description, Date creationDate, Map<String,String> analysisParameters, int discoveryRequestStatus, Map<String,String> additionalProperties, String methodName)`	Update the properties of the discovery analysis report.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, entityMatchSearchCriteria, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, findEntities, getAllAttachmentLinks, getAnchorGUIDFromAnchorsClassification, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntitiesFromUser, getAttachedEntity, getAttachedEntity, getAttachedEntity, getAttachedEntityFromUser, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachedFilteredEntities, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEffectiveTime, getEffectiveTime, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getTypeDefByName, getUniqueAttachmentLink, getUniqueAttachmentLink, isBeanIsolated, isEntityATypeOf, linkElementToElement, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, regexSearchCriteria, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, validateUniqueProperty, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiscoveryAnalysisReportHandler

public DiscoveryAnalysisReportHandler(OpenMetadataAPIGenericConverter<B> converter,
                                      Class<B> beanClass,
                                      String serviceName,
                                      String serverName,
                                      InvalidParameterHandler invalidParameterHandler,
                                      RepositoryHandler repositoryHandler,
                                      OMRSRepositoryHelper repositoryHelper,
                                      String localServerUserId,
                                      OpenMetadataServerSecurityVerifier securityVerifier,
                                      List<String> supportedZones,
                                      List<String> defaultZones,
                                      List<String> publishZones,
                                      AuditLog auditLog)

Construct the handler with information needed to work with B objects.

Parameters:: converter - specific converter for this bean class; beanClass - name of bean class that is represented by the generic class B; serviceName - name of this service; serverName - name of the local server; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - manages calls to the repository services; repositoryHelper - provides utilities for manipulating the repository services objects; localServerUserId - userId for this server; securityVerifier - open metadata security services verifier; supportedZones - list of zones that the access service is allowed to serve B instances from.; defaultZones - list of zones that the access service should set in all new B instances.; publishZones - list of zones that the access service sets up in published B instances.; auditLog - destination for audit log events.

Method Detail

createDiscoveryAnalysisReport

public String createDiscoveryAnalysisReport(String userId,
                                            String qualifiedName,
                                            String displayName,
                                            String description,
                                            Date creationDate,
                                            Map<String,String> analysisParameters,
                                            int discoveryRequestStatus,
                                            String assetGUID,
                                            String discoveryEngineGUID,
                                            String discoveryServiceGUID,
                                            Map<String,String> additionalProperties,
                                            String methodName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Create a new discovery analysis report and chain it to its asset, discovery engine and discovery service.

Parameters:: userId - calling user; qualifiedName - unique name for the report; displayName - short name for the report; description - description of the report; creationDate - data of the report; analysisParameters - analysis parameters passed to the discovery service; discoveryRequestStatus - current status of the discovery processing; assetGUID - unique identifier of the asset being analysed; discoveryEngineGUID - unique identifier of the discovery engine that is running the discovery service; discoveryServiceGUID - unique identifier of the discovery service creating the report; additionalProperties - additional properties for the report; methodName - calling method
Returns:: The new discovery report.
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to access the asset and/or report; PropertyServerException - there was a problem in the store whether the asset/report properties are kept.

updateDiscoveryAnalysisReport

public void updateDiscoveryAnalysisReport(String userId,
                                          String discoveryReportGUID,
                                          String qualifiedName,
                                          String displayName,
                                          String description,
                                          Date creationDate,
                                          Map<String,String> analysisParameters,
                                          int discoveryRequestStatus,
                                          Map<String,String> additionalProperties,
                                          String methodName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Update the properties of the discovery analysis report.

Parameters:: userId - calling user.; discoveryReportGUID - identifier of the discovery report; qualifiedName - unique name for the report; displayName - short name for the report; description - description of the report; creationDate - data of the report; analysisParameters - analysis parameters passed to the discovery service; discoveryRequestStatus - current status of the discovery processing; additionalProperties - additional properties for the report; methodName - calling method
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.

getDiscoveryAnalysisReport

public B getDiscoveryAnalysisReport(String userId,
                                    String discoveryReportGUID,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Request the discovery report for a discovery request that has completed.

Parameters:: userId - identifier of calling user; discoveryReportGUID - identifier of the discovery request.; methodName - calling method
Returns:: discovery report
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

public List<B> getDiscoveryAnalysisReports(String userId,
                                           String assetGUID,
                                           int startingFrom,
                                           int maximumResults,
                                           String methodName)
                                    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; methodName - calling method
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.

Class DiscoveryAnalysisReportHandler<B>

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler