SearchQueryCollection Class Methods
In this section, the SearchQueryCollection class methods are presented in alphabetical order.
Syntax
addQuery(&srch_qry)
Description
Use this method to add a search query to the search query collection. The addQuery method can be called repeatedly to add multiple search queries to the collection.
Parameters
|
Field or Control |
Definition |
|---|---|
| &srch_qry |
Specifies the query as a SearchQuery object. |
Returns
None.
Syntax
Count()
Description
Use this method to return the number of SearchQuery objects in the search query collection as an integer.
Parameters
None.
Returns
An Integer value.
Syntax
ExecuteQuerys()
Description
Use this method to run multiple search queries in parallel. The ExecuteQuerys method returns an array of SearchResultCollection objects, one for each search query executed. If any of the search queries fails, ExecuteQuerys throws an exception.
Note: The number of parallel requests is determined by the thread pool size that is defined in the application server configuration file (psappsrv.cfg).
Parameters
None.
Returns
An array of SearchResultsCollection objects.
Syntax
First()
Description
Use this method to return the first SearchQuery object in the search query collection. If the search query collection is empty, this method returns Null.
Parameters
None.
Returns
A SearchQuery object if successful, Null otherwise.
Syntax
Item(index)
Description
Use this method to return the SearchQuery object at the position in the search query collection specified by the index parameter.
Parameters
|
Field or Control |
Definition |
|---|---|
| &index |
Specifies the position of the SearchQuery object in the search query collection as an integer. |
Returns
A SearchQuery object if successful, Null otherwise.
Syntax
Next()
Description
Use this method to return the next SearchQuery object in the search query collection. This method can only be invoked after a successful invocation of the First, Item, or Next methods.
Parameters
None.
Returns
A SearchQuery object if successful, Null otherwise.