Siebel Object Interfaces Reference > Interfaces Reference > Business Component Methods >

SetNamedSearch


SetNamedSearch sets a named search specification on the business component. A named search specification is identified by the searchName argument.

Syntax

oBusComp.SetNamedSearch searchName, searchSpec

Argument
Description
searchName
String containing the name of the named search specification
searchSpec
String containing the search specification string corresponding to the name

Returns

Not applicable

Usage

A named search specification is a search criterion that is not cleared by the ClearToQuery; for example, a predefined query or business component search specification.

A named search specification can be modified only programmatically; it cannot be modified through the UI. This specification is applied in conjunction with the existing search specification. Once set, the named search specification is applied every time ExecuteQuery is called. ClearToQuery does not clear the named search specification. To clear it, explicitly set the searchSpec argument to "". Note that when a new instance of the BusComp is created, the named search specification is cleared.

The searchSpec argument assigned to SetNamedSearch is the same argument that is used after the equal sign in a predefined query. The maximum length of a predefined query is 2000 characters. For details on how to set up the search specification, read SetSearchExpr and SetSearchSpec.

Used With

Server Script, Mobile/Dedicated Web Client Automation Server, COM Data Control, COM Data Server, Java Data Bean, CORBA Object Manager

See Also

GetNamedSearch
SetSearchSpec


 Siebel Object Interfaces Reference 
 Published: 18 June 2003