Package org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops

Class GetEntityHistory

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractReadOperation

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractHistoryOperation

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.GetEntityHistory

public class GetEntityHistory
extends AbstractHistoryOperation

Implements the 'getEntityDetailHistory' operation of the OMRS metadata collection interface.

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractHistoryOperation

fromElement, fromTime, instanceGUID, pageSize, sequencingOrder

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractReadOperation

asOfTime, existingDB, xtdb

Constructor Summary

Constructors

Constructor	Description
GetEntityHistory(XTDBOMRSRepositoryConnector xtdb, String instanceGUID, Date fromTime, Date toTime, int fromElement, int pageSize, HistorySequencingOrder sequencingOrder)	Create a new entity history retrieval operation.

Method Summary

Modifier and Type	Method	Description
List<EntityDetail>	execute()	Retrieve previous versions of the entity between the provided dates, ordered as requested.

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractHistoryOperation

getPreviousVersions

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.readops.AbstractReadOperation

getXtdbObjectByReference

Methods inherited from class java.lang.Object

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

Constructor Details

GetEntityHistory

public GetEntityHistory(XTDBOMRSRepositoryConnector xtdb,
 String instanceGUID,
 Date fromTime,
 Date toTime,
 int fromElement,
 int pageSize,
 HistorySequencingOrder sequencingOrder)

Create a new entity history retrieval operation.

Parameters:

xtdb - connectivity to XTDB

instanceGUID - unique identifier of a metadata instance for which to retrieve history

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)

fromElement - starting element for paged results

pageSize - the number of results to include per page

sequencingOrder - Enum defining how the results should be ordered.

Method Details

execute

public List<EntityDetail> execute()
                           throws EntityNotKnownException,
RepositoryErrorException

Retrieve previous versions of the entity between the provided dates, ordered as requested.

Returns:

List<EntityDetail> giving all versions of the entity within the range requested

Throws:

EntityNotKnownException - if the requested entity was not known to the repository during the specified time range

RepositoryErrorException - if any issue closing the lazy-evaluating cursor