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

Class GetEntityDetailHistoryExecutor

java.lang.Object

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

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

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

All Implemented Interfaces:

CloneableRepositoryExecutor, RepositoryExecutor

public class GetEntityDetailHistoryExecutor
extends PageableEntityRepositoryExecutorBase

GetEntityDetailHistoryExecutor is the executor for the findEntitiesByPropertyValue request. This request can be issued in parallel - the call to each request potentially running in a different thread.

Field Summary

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

methodName, userId

Constructor Summary

Constructors

Constructor	Description
GetEntityDetailHistoryExecutor(String userId, String guid, Date fromTime, Date toTime, int startFromElement, int pageSize, HistorySequencingOrder sequencingOrder, String localMetadataCollectionId, AuditLog auditLog, OMRSRepositoryValidator repositoryValidator, String methodName)	Create the executor.

Method Summary

Modifier and Type	Method	Description
CloneableRepositoryExecutor	getClone()	Return a clone of this executor with the same command parameters and accumulator instance.
List<EntityDetail>	getHistoryResults(EnterpriseOMRSRepositoryConnector repositoryConnector, OMRSMetadataCollection metadataCollection)	Return the results or exception.
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.PageableEntityRepositoryExecutorBase

augmentResultFromRepository, getResults, 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

GetEntityDetailHistoryExecutor

public GetEntityDetailHistoryExecutor(String userId,
 String guid,
 Date fromTime,
 Date toTime,
 int startFromElement,
 int pageSize,
 HistorySequencingOrder sequencingOrder,
 String localMetadataCollectionId,
 AuditLog auditLog,
 OMRSRepositoryValidator repositoryValidator,
 String methodName)

Create the executor. The parameters provide the parameters for issuing the requests and combining the results.

Parameters:

userId - unique identifier for requesting user.

guid - String unique identifier for the entity.

fromTime - the earliest point in time from which to retrieve historical versions of the entity (inclusive)

toTime - the latest point in time from which to retrieve historical versions of the entity (exclusive)

startFromElement - the starting element number of the historical versions to return. This is used when retrieving versions beyond the first page of results. Zero means start from the first element.

pageSize - the maximum number of result versions that can be returned on this request. Zero means unrestricted return results size.

sequencingOrder - Enum defining how the results should be ordered.

localMetadataCollectionId - unique identifier for the local repository - may be null if no local repository

auditLog - logging destination

repositoryValidator - validator for resulting relationships

methodName - calling method

Method Details

getClone

public CloneableRepositoryExecutor getClone()

Return a clone of this executor with the same command parameters and accumulator instance. This is used when setting up the parallel execution of the work. Each clone executes the calls to a single open metadata repository.

Returns:

clone of this executor

issueRequestToRepository

public boolean issueRequestToRepository(String metadataCollectionId,
 OMRSMetadataCollection metadataCollection)

Perform the required action for the supplied 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

getHistoryResults

public List<EntityDetail> getHistoryResults(EnterpriseOMRSRepositoryConnector repositoryConnector,
 OMRSMetadataCollection metadataCollection)
                                     throws InvalidParameterException,
RepositoryErrorException,
EntityNotKnownException,
EntityProxyOnlyException,
FunctionNotSupportedException,
UserNotAuthorizedException

Return the results or exception.

Parameters:

repositoryConnector - enterprise connector

metadataCollection - enterprise metadata collection

Returns:

a list of entities matching the supplied criteria; null means no matching entities in the metadata collection.

Throws:

InvalidParameterException - a parameter is invalid or null.

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

FunctionNotSupportedException - the repository does not support the asOfTime parameter.

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

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

EntityProxyOnlyException - the requested entity instance is only a proxy in the metadata collection.