Class PagingCursorbased<T>

  • Type Parameters:
    T - The type of the objects contained in a paging object.
    All Implemented Interfaces:
    IModelObject

    public class PagingCursorbased<T>
    extends AbstractModelObject
    Retrieve information about cursor-based Paging objects by building instances from this class.
    This cursor-based paging object is a container for a set of objects.
    • Method Summary

      Modifier and Type Method Description
      PagingCursorbased.Builder<T> builder()
      Create a builder for building an instance of a model object.
      Cursor[] getCursors()
      Get the cursors used to find the next set of items.
      java.lang.String getHref()
      Get a link to the Web API endpoint returning the full result of the request.
      T[] getItems()
      Get the items contained in the paging object.
      java.lang.Integer getLimit()
      Get the maximum number of items in the response (as set in the query or by default).
      java.lang.String getNext()
      Get the URL to the next page of items.
      java.lang.Integer getTotal()
      Get the total number of items available to return.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getHref

        public java.lang.String getHref()
        Get a link to the Web API endpoint returning the full result of the request.
        Returns:
        A link to the Web API endpoint returning the full result of the request.
      • getItems

        public T[] getItems()
        Get the items contained in the paging object.
        Returns:
        The items contained in the paging object.
      • getLimit

        public java.lang.Integer getLimit()
        Get the maximum number of items in the response (as set in the query or by default).
        Returns:
        The maximum number of items in the response (as set in the query or by default).
      • getNext

        public java.lang.String getNext()
        Get the URL to the next page of items. (null if none)
        Returns:
        URL to the next page of items. (null if none)
      • getCursors

        public Cursor[] getCursors()
        Get the cursors used to find the next set of items.
        Returns:
        The cursors used to find the next set of items.
      • getTotal

        public java.lang.Integer getTotal()
        Get the total number of items available to return.
        Returns:
        The total number of items available to return.
      • builder

        public PagingCursorbased.Builder<T> builder()
        Description copied from interface: IModelObject
        Create a builder for building an instance of a model object.
        The type of the builder and its methods depend on its corresponding implementation.
        Returns:
        A builder object.