Class HistoryRangeRequest

  • All Implemented Interfaces:
    java.io.Serializable

    public class HistoryRangeRequest
    extends OMRSAPIRequest
    HistoryRequest carries the date/time for a historical query.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      java.util.Date getFromTime()
      Return the earliest point of history to retrieve (inclusive).
      int getOffset()
      Return the starting element number for this set of results.
      int getPageSize()
      Return the maximum number of elements that can be returned on this request.
      HistorySequencingOrder getSequencingOrder()
      Return the sequencing order for the results.
      java.util.Date getToTime()
      Return the latest point of history up to which to return (exclusive).
      int hashCode()
      Create a hash code for this element type.
      void setFromTime​(java.util.Date fromTime)
      Set up the earliest point of history to retrieve (inclusive).
      void setOffset​(int offset)
      Set up the starting element number for this set of results.
      void setPageSize​(int pageSize)
      Set up the maximum number of elements that can be returned on this request.
      void setSequencingOrder​(HistorySequencingOrder sequencingOrder)
      Set up the sequencing order for the results.
      void setToTime​(java.util.Date toTime)
      Set up the latest point of history up to which to return (exclusive).
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • HistoryRangeRequest

        public HistoryRangeRequest()
        Default constructor
      • HistoryRangeRequest

        public HistoryRangeRequest​(HistoryRangeRequest template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getFromTime

        public java.util.Date getFromTime()
        Return the earliest point of history to retrieve (inclusive).
        Returns:
        date/time
      • setFromTime

        public void setFromTime​(java.util.Date fromTime)
        Set up the earliest point of history to retrieve (inclusive).
        Parameters:
        fromTime - date/time
      • getToTime

        public java.util.Date getToTime()
        Return the latest point of history up to which to return (exclusive).
        Returns:
        date/time
      • setToTime

        public void setToTime​(java.util.Date toTime)
        Set up the latest point of history up to which to return (exclusive).
        Parameters:
        toTime - date/time
      • getOffset

        public int getOffset()
        Return the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.
        Returns:
        offset number
      • setOffset

        public void setOffset​(int offset)
        Set up the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.
        Parameters:
        offset - offset number
      • getPageSize

        public int getPageSize()
        Return the maximum number of elements that can be returned on this request.
        Returns:
        page size
      • setPageSize

        public void setPageSize​(int pageSize)
        Set up the maximum number of elements that can be returned on this request.
        Parameters:
        pageSize - integer number
      • getSequencingOrder

        public HistorySequencingOrder getSequencingOrder()
        Return the sequencing order for the results.
        Returns:
        sequencing order enum
      • setSequencingOrder

        public void setSequencingOrder​(HistorySequencingOrder sequencingOrder)
        Set up the sequencing order for the results.
        Parameters:
        sequencingOrder - sequencing order enum
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Create a hash code for this element type.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int hash code