Package org.alfresco.repo.web.util.paging

Interface Cursor

All Known Implementing Classes:
PagedCursor, WindowedCursor
public interface Cursor
Cursor - Allows for scrolling through a row set.
Author:
davidc

  • Method Details

    • getPageType

      String getPageType()
      Gets the page type
      Returns:
      page type

    • getPageSize

      int getPageSize()
      Gets the page size
      Returns:
      page size

    • getTotalPages

      int getTotalPages()
      Gets total number of pages
      Returns:
      total number of pages

    • getTotalRows

      int getTotalRows()
      Gets total rows
      Returns:
      total rows

    • getCurrentPage

      int getCurrentPage()
      Gets the current page number
      Returns:
      current page number

    • getFirstPage

      int getFirstPage()
      Gets the first page number
      Returns:
      first page number

    • getLastPage

      int getLastPage()
      Gets the last page number
      Returns:
      last page number

    • getNextPage

      int getNextPage()
      Gets the next page number
      Returns:
      next page number (-1 if no more pages)

    • getPrevPage

      int getPrevPage()
      Gets the previous page number
      Returns:
      previous page number (-1 if no previous pages)

    • isInRange

      boolean isInRange()
      Is the page within range of the result set
      Returns:
      true => page is within range

    • getHasFirstPage

      boolean getHasFirstPage()
      Is there a known first page?
      Returns:
      true => getFirstPage() will succeed

    • getHasLastPage

      boolean getHasLastPage()
      Is there a known last page?
      Returns:
      true => getLastPage() will succeed

    • getHasNextPage

      boolean getHasNextPage()
      Is there a known next page?
      Returns:
      true => getNextPage() will succeed

    • getHasPrevPage

      boolean getHasPrevPage()
      Is there a known prev page?
      Returns:
      true => getPrevPage() will succeed

    • getStartRow

      int getStartRow()
      Gets the start row within result set for this page
      Returns:
      start row index

    • getEndRow

      int getEndRow()
      Gets the end row within result set for this page
      Returns:
      end row index

    • getRowCount

      int getRowCount()
      Gets the count of rows within result set for this page
      Returns:
      row count