Class GetRelationshipHistory


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

      • GetRelationshipHistory

        public GetRelationshipHistory​(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 relationship 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 relationship (inclusive)
        toTime - the latest point in time from which to retrieve historical versions of the relationship (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.Relationship> execute()
                                                                                                                                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotKnownException,
                                                                                                                                                  org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Retrieve previous versions of the relationship between the provided dates, ordered as requested.
        Returns:
        List<Relationship> giving all versions of the relationship within the range requested
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotKnownException - if the requested relationship 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