1. Object Interfaces Reference
  2. ClearToQuery Method for a Business Component

ClearToQuery Method for a Business Component

The ClearToQuery method clears the current query but does not clear sort specifications on a business component. This method does not return any information. For more information, see RefineQuery Method for a Business Component.

Format

BusComp.ClearToQuery

No arguments are available.

Usage

You must use the ActivateField method to activate a field before you can use the ClearToQuery method. For more information, see ActivateField Method for a Business Component.

Search and sort specifications sent to a business component are cumulative. The business component retains and logically performs an AND operation for the queries that accumulate since the last time Siebel CRM performed the ClearToQuery method. This situation is true except if there is a new search specification on a field, and if that field already included a search specification. In this situation, the new search specification replaces the old search specification.

Used With

COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script

Examples

The following example is in Siebel eScript. 

var oEmpBusObj = TheApplication().ActiveBusObject();
var oEmpBusComp = oEmpBusObj ().GetBusComp("Employee");
var sLoginName;

oEmpBusComp.ClearToQuery();
oEmpBusComp.SetSearchSpec("Login Name", sLoginName);
oEmpBusComp.ExecuteQuery(ForwardBackward);

oEmpBusComp = null;
oEmpBusObj = null;

For more examples, see the following: