Defines a custom SQL search function that can be invoked during a background search. Specify the function name with the CmFunctionName property. If a handler requires configuration settings to control its operation, create a subclass of CmSearchFunctionDefinition and extend it with custom properties.

The function is coded by the user as a Java™ or JavaScript implementation of the ICmSearchFunctionDefinition interface. The user-implemented action is set on ICmSearchFunctionDefinition with the CodeModule or ScriptText property, depending on how the action is implemented.

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

ToggleSyntax

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

ToggleRemarks

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Action

ToggleSee Also