Package org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors

Class GetEntitySummaryExecutor

java.lang.Object

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.GetEntityExecutor

org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.GetEntitySummaryExecutor

All Implemented Interfaces:

RepositoryExecutor

public class GetEntitySummaryExecutor
extends GetEntityExecutor

GetEntitySummaryExecutor provides the executor for the getEntitySummary method.

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.GetEntityExecutor

entityGUID

Fields inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

methodName, userId

Constructor Summary

Constructors

Constructor	Description
GetEntitySummaryExecutor(String userId, String entityGUID, AuditLog auditLog, String methodName)	Constructor takes the parameters for the request.

Method Summary

Modifier and Type	Method	Description
EntitySummary	getEntitySummary()	Return the entity and accumulated classifications.
boolean	issueRequestToRepository(String metadataCollectionId, OMRSMetadataCollection metadataCollection)	Perform the required action for the supplied repository.

Methods inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.GetEntityExecutor

augmentResultFromRepository, getHomeClassifications, getResultsForAugmentation

Methods inherited from class org.odpi.openmetadata.repositoryservices.enterprise.repositoryconnector.executors.RepositoryExecutorBase

getMethodName

Methods inherited from class java.lang.Object

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

Constructor Details

GetEntitySummaryExecutor

public GetEntitySummaryExecutor(String userId,
 String entityGUID,
 AuditLog auditLog,
 String methodName)

Constructor takes the parameters for the request.

Parameters:

userId - unique identifier for requesting user

entityGUID - unique identifier (guid) for the entity

auditLog - logging destination

methodName - calling method

Method Details

issueRequestToRepository

public boolean issueRequestToRepository(String metadataCollectionId,
 OMRSMetadataCollection metadataCollection)

Perform the required action for the supplied repository. Create requests occur in the first repository that accepts the call. Some repositories may produce exceptions. These exceptions are saved and will be returned if there are no positive results from any repository.

Specified by:

issueRequestToRepository in interface RepositoryExecutor

Specified by:

issueRequestToRepository in class RepositoryExecutorBase

Parameters:

metadataCollectionId - unique identifier for the metadata collection for the repository

metadataCollection - metadata collection object for the repository

Returns:

boolean true means that the required results have been achieved

getEntitySummary

public EntitySummary getEntitySummary()
                               throws InvalidParameterException,
RepositoryErrorException,
EntityNotKnownException,
UserNotAuthorizedException

Return the entity and accumulated classifications. The returned entity summary may be from a full entity object or an entity proxy.

Returns:

EntitySummary structure

Throws:

InvalidParameterException - the guid is null

RepositoryErrorException - there is a problem communicating with the metadata repository where the metadata collection is stored.

EntityNotKnownException - the requested entity instance is not known in the metadata collection.

UserNotAuthorizedException - the userId is not permitted to perform this operation.