com.ibm.jarm.api.collection

Interface PageableSet<T>

  • All Superinterfaces:
    java.lang.Iterable<T>


    public interface PageableSet<T>
    extends java.lang.Iterable<T>
    A parameterized Set collection that supports paging.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean isEmpty()
      Indicates whether the associated collection is empty or not.
      java.util.Iterator<T> iterator()
      Provides a parameterized Iterator instance for the elements in the collection.
      RMPageIterator<T> pageIterator()
      Provides a RMPageIterator that you can use to page through the elements in the collection.
      boolean supportsPaging()
      Indicates whether this instance supports paging.
      java.lang.Integer totalCount()
      Returns the count requested in a search that includes OPTIONS (COUNT_LIMIT N).
    • Method Detail

      • isEmpty

        boolean isEmpty()
        Indicates whether the associated collection is empty or not.
        Returns:
        true if the collection is empty.
      • supportsPaging

        boolean supportsPaging()
        Indicates whether this instance supports paging. If true, you can use the pageIterator() method to retrieve a RMPageIterator. Otherwise, use the standard Iterator.
        Returns:
        true if this instance supports the use of a page iterator.
      • pageIterator

        RMPageIterator<T> pageIterator()
        Provides a RMPageIterator that you can use to page through the elements in the collection.
        Returns:
        A RMPageIterator of the parameterized type.
        Throws:
        RAL_PAGING_NOT_SUPPORTED - if this instance does not support paging.
      • iterator

        java.util.Iterator<T> iterator()
        Provides a parameterized Iterator instance for the elements in the collection.
        Specified by:
        iterator in interface java.lang.Iterable<T>
        Returns:
        A parameterized Iterator instance.
      • totalCount

        java.lang.Integer totalCount()
        Returns the count requested in a search that includes OPTIONS (COUNT_LIMIT N). This method is only supported by P8 CE 5.2 or later repository type.
        Returns:
        An integer value of search total count. The possible values are:
        • A null value to indicate that this is the last page, the count limit is less than or equal to the page size, counting is disabled on the server, or the P8 CE version is earlier than 5.2.
        • A value greater than zero to indicate an exact count; that is, all the rows were found, and the number found is less than the count limit.
        • A negative of the COUNT_LIMIT value to indicate that the minimum count was found, meaning that the count is at least N. If Top M is specified on the search, counting is not done past M, and and exact count is returned if the number of rows found is less than or equal to M when M <= N.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.