Package com.documentum.fc.client.search

# Interface IDfPassThroughQuery

All Superinterfaces:
  `IDfQueryDefinition`, `IDfSearchSourceContainer`

public interface IDfPassThroughQuery extends IDfQueryDefinition
Provides a container for passing a query string directly to the search source. It also allows you to store custom data as a `String`. It can be useful when storing a query, especially when a custom query building process is used to generate the query string.

See Also:
  - `IDfQueryManager.newPassThroughQuery(String)`

- ## Field Summary

  ### Fields inherited from interface com.documentum.fc.client.search.IDfQueryDefinition

  `QUERY_DEF_TYPE_BUILDER, QUERY_DEF_TYPE_PASSTHROUGH, QUERY_DEF_TYPE_UNDEFINED`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getCustomQueryData()`
  Gets the content of the query custom data.
  `String`
  `getQueryString()`
  Gets the content of the query string.

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

  `copy, getMaxResultCount, getMaxResultPerSource, getMetadataMgr, getQueryDefinitionType, isQueryBuilder, setMaxResultCount, setMaxResultPerSource`

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

  `addSelectedSource, clearSelectedSources, getSelectedSourceCount, getSelectedSources, removeSelectedSource`

- ## Method Details

  - ### getQueryString

    String getQueryString()
    Gets the content of the query string.
    Returns:
      The content of the query string.

  - ### getCustomQueryData

    String getCustomQueryData()
    Gets the content of the query custom data.
    Returns:
      The content of the query custom data.