Determines which repository or repositories are to be searched, and supplies methods to execute searches for properties, objects, and class metadata (class descriptions).

When multiple repositories are to be searched, use the SearchScope(ObjectStore[], MergeMode) (broken link "!:FileNet.Api.Query.SearchScope(IObjectStore[] objectStores, MergeMode mergeMode)") to specify whether the scope is the union or intersection of the object stores.

This class cannot be inherited.

The following tables list the members exposed by SearchScope.

Public Constructors

 NameDescription
StaticPublic methodSearchScopeOverloaded.  
Top

Public Methods

 NameDescription
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (inherited from Object)
Public methodFetchObjectsRetrieves EngineObject objects from the repository or repositories specified for the SearchScope instance.

The following property settings can affect this method:

  • ObjectStore.DefaultQueryTimeLimit
  • ObjectStore.MaxQueryTimeLimit
  • IServerCacheConfiguration.QueryPageMaxSize
  • IServerCacheConfiguration.QueryPageDefaultSize
  • IServerCacheConfiguration.NonPagedQueryMaxSize
Public methodFetchRowsRetrieves rows of properties (Properties objects) from the repository or repositories specified for the this instance.

The following property settings can affect this method:

  • ObjectStore.DefaultQueryTimeLimit
  • ObjectStore.MaxQueryTimeLimit
  • IServerCacheConfiguration.QueryPageMaxSize
  • IServerCacheConfiguration.QueryPageDefaultSize
  • IServerCacheConfiguration.NonPagedQueryMaxSize
Public methodFetchSearchableClassDescriptionsRetrieves ClassDescription objects from the repository or repositories specified for this instance.
Public methodGetHashCodeServes as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (inherited from Object)
Public methodGetMergeModeReturns the merge mode used for the search. The merge mode defaults to UNION when unspecified.
Public methodGetObjectStoresReturns the repositories used as the search scope.
Public methodGetTypeGets the Type of the current instance. (inherited from Object)
Public methodToStringReturns a String that represents the current Object. (inherited from Object)
Top

Explicit Interface Implementations

 NameDescription
StaticPrivate methodSearchScopeOverloaded.  
Top

See Also