Package com.documentum.fc.client.search

# Interface IDfQueryScope

All Known Subinterfaces:
  `IDfExpressionScope`, `IDfLocationQueryScope`, `IDfPartitionScope`

public interface IDfQueryScope
This is a base interface for the query scope. Scopes are used to provide constraints for the query in a source-dependent way. For example, `IDfLocationQueryScope` allows you to specify a location within the source independently from the query expressions.

See Also:
  - `IDfLocationQueryScope`
  - `IDfPartitionScope`
  - `IDfExpressionScope`

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final int`
  `SCOPE_EXPRESSION`
  Indicates the expression scope type.
  `static final int`
  `SCOPE_LOCATION`
  Indicates the location query scope type.
  `static final int`
  `SCOPE_PARTITION`
  Indicates the partition scope type.
  `static final int`
  `SCOPE_UNDEFINED`
  Internal scope type used to identify uninitialized scope.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getScopeType()`
  Gets the type of a scope.

- ## Field Details

  - ### SCOPE_UNDEFINED

    static final int SCOPE_UNDEFINED
    Internal scope type used to identify uninitialized scope.
    See Also:
      - Constant Field Values

  - ### SCOPE_LOCATION

    static final int SCOPE_LOCATION
    Indicates the location query scope type.
    See Also:
      - Constant Field Values

  - ### SCOPE_PARTITION

    static final int SCOPE_PARTITION
    Indicates the partition scope type.
    See Also:
      - Constant Field Values

  - ### SCOPE_EXPRESSION

    static final int SCOPE_EXPRESSION
    Indicates the expression scope type.
    See Also:
      - Constant Field Values

- ## Method Details

  - ### getScopeType

    int getScopeType()
    Gets the type of a scope. It can be one of the following types:
    - `SCOPE_PARTITION`
    - `SCOPE_LOCATION`
    - `SCOPE_EXPRESSION`
    Returns:
      Type of the scope for the current instance.