Package com.documentum.fc.client.search

# Interface IDfSearchSourceContainer

All Known Subinterfaces:
  `IDfPassThroughQuery`, `IDfQueryBuilder`, `IDfQueryDefinition`, `IDfSearchMetadataManager`

public interface IDfSearchSourceContainer
Base interface for the classes that manage a list of selected sources.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addSelectedSource(String sourceName)`
  Adds a selected source.
  `void`
  `clearSelectedSources()`
  Removes all selected sources.
  `int`
  `getSelectedSourceCount()`
  Gets the selected source count.
  `IDfEnumeration`
  `getSelectedSources()`
  Gets an enumeration of the selected sources.
  `void`
  `removeSelectedSource(String sourceName)`
  Removes selected source.

- ## Method Details

  - ### getSelectedSourceCount

    int getSelectedSourceCount()
    Gets the selected source count. Default is 0.
    Returns:
      The number of selected sources.

  - ### getSelectedSources

    IDfEnumeration getSelectedSources()
    Gets an enumeration of the selected sources.
    Returns:
      An enumeration of IDfSearchSource objects.

  - ### addSelectedSource

    void addSelectedSource(String sourceName) throws DfException
    Adds a selected source. Internally, looks up the source by name using the bound IDfSearchMetadataManager.
    Parameters:
      `sourceName` - The name of the source to add.
    Throws:
      `DfException` - If source cannot be added such as in a case if it cannot be located.

  - ### removeSelectedSource

    void removeSelectedSource(String sourceName) throws DfException
    Removes selected source.
    Parameters:
      `sourceName` - The name of the source to remove.
    Throws:
      `DfException` - If a problem with accessing sources happens.

  - ### clearSelectedSources

    void clearSelectedSources() throws DfException
    Removes all selected sources.
    Throws:
      `DfException` - If a problem with accessing sources happens.