Package com.documentum.fc.client.search

# Interface IDfModifiableResultsSet

All Superinterfaces:
  `IDfResultsSet`

public interface IDfModifiableResultsSet extends IDfResultsSet
Represents a list of results and defines the methods necessary to modify and manipulate it.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `add(IDfResultEntry entry)`
  Adds an entry at the end of this set.
  `IDfResultsSet`
  `sort(String attributeName, boolean ascend, String locale)`
  Returns a sorted set.
  `IDfResultsSet`
  `subset(int from)`
  Gets a subset of this results set based on a beginning index.
  `IDfResultsSet`
  `subset(int from, int to)`
  Gets a subset of this results set based on a beginning and ending index.

  ### Methods inherited from interface com.documentum.fc.client.search.IDfResultsSet

  `getResult, getResultAt, getResultByKey, next, reset, size`

- ## Method Details

  - ### add

    void add(IDfResultEntry entry)
    Adds an entry at the end of this set.

  - ### sort

    IDfResultsSet sort(String attributeName, boolean ascend, String locale)
    Returns a sorted set.

  - ### subset

    IDfResultsSet subset(int from, int to)
    Gets a subset of this results set based on a beginning and ending index.
    Parameters:
      `from` - The beginning index (inclusive).
      `to` - The ending index (exclusive).
    Returns:
      A new results set (copy of the underlying list, reference to the same results).

  - ### subset

    IDfResultsSet subset(int from)
    Gets a subset of this results set based on a beginning index.
    Parameters:
      `from` - The beginning index (inclusive).
    Returns:
      A new results set (copy of the underlying list, reference to the same results).