The base class from which you can create a subclass to define the search expression and parameters for a background search. The CmBackgroundSearch class is derived from the CmSweep class and its instances are stored in the Sweep table. The base CmBackgroundSearch class cannot be instantiated.

After you define a background search in a CmBackgroundSearch subclass, you start the background search by instantiating the subclass, providing values to those object properties that define parameters, and saving the object.

To define the search expression of the background search, set the default value of the SearchExpression property definition of a CmBackgroundSearch subclass definition to a valid Content Platform Engine SQL expression. This SQL expression has a syntax extension for specifying parameter substitution. Parameters are defined by custom properties that you add to a CmBackgroundSearch subclass to define a particular search. The name of each parameter must match the symbolic name of a custom property.

Namespace:  FileNet.Api.Sweep
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Interface ICmBackgroundSearch _
	Implements ICmSweep, IRepositoryObject, ISubscribable, IIndependentlyPersistableObject,  _
	IIndependentObject, IEngineObject, ICloneable
C#
public interface ICmBackgroundSearch : ICmSweep, 
	IRepositoryObject, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, 
	ICloneable
Visual C++
public interface class ICmBackgroundSearch : ICmSweep, 
	IRepositoryObject, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, 
	ICloneable
JavaScript
FileNet.Api.Sweep.ICmBackgroundSearch = function();
FileNet.Api.Sweep.ICmBackgroundSearch.createInterface('FileNet.Api.Sweep.ICmBackgroundSearch');

ToggleRemarks

Metadata

Auditable: true
AllowsInstances: false
AllowsSubClasses: true
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: CmSweep

ToggleSee Also