Class GetEntityHistory


  • public class GetEntityHistory
    extends AbstractHistoryOperation
    Implements the 'getEntityDetailHistory' operation of the OMRS metadata collection interface.
    • Constructor Detail

      • GetEntityHistory

        public GetEntityHistory​(XtdbOMRSRepositoryConnector xtdb,
                                String instanceGUID,
                                Date fromTime,
                                Date toTime,
                                int fromElement,
                                int pageSize,
                                org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.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 Detail

      • execute

        public List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> execute()
                                                                                                                                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException,
                                                                                                                                                  org.odpi.openmetadata.repositoryservices.ffdc.exception.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:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException - if the requested entity was not known to the repository during the specified time range
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - if any issue closing the lazy-evaluating cursor