Package com.documentum.fc.client.search

Interface IDfResultsSet

All Known Subinterfaces:
IDfModifiableResultsSet
public interface IDfResultsSet
Represents a list of results. It can be accessed either using a cursor or using direct index.

  • Method Summary

    Modifier and Type
    Method
    Description
    IDfResultEntry
    getResult()
    Gets the current result.
    IDfResultEntry
    getResultAt(int index)
    Gets the result at a specified index.
    IDfResultEntry
    getResultByKey(String key)
    Gets the result that is represented by the specified String key.
    boolean
    next()
    Goes to the next result.
    void
    reset()
    Resets the cursor to the start of the list.
    int
    size()
    Gets the number of results in the list.

  • Method Details

    • next

      boolean next()
      Goes to the next result.
      Returns:
      true, if there is result available; false if the end of the list has been reached.

    • getResult

      IDfResultEntry getResult()
      Gets the current result.
      Returns:
      An IDfResultEntry object representing the current result entry.

    • reset

      void reset()
      Resets the cursor to the start of the list.

    • getResultAt

      IDfResultEntry getResultAt(int index)
      Gets the result at a specified index.
      Parameters:
      index - An int between 0 and the size of the list minus 1.
      Returns:
      An IDfResultEntry object representing the result entry at a specified index.

    • getResultByKey

      IDfResultEntry getResultByKey(String key) throws DfException
      Gets the result that is represented by the specified String key.
      Parameters:
      key - A String key for the result.
      Returns:
      A result entry or null if the specified key has not been found.
      Throws:
      DfException
      See Also:

    • size

      int size()
      Gets the number of results in the list.
      Returns:
      The number of results in the list.