Services Integration Framework Guide

10.5

Back Next

GetSearchResults

retrieves additional pages of records for any API with paging enabled. The APIs that support paging are:

GetAssignedRecords

Get Matched Records

GetOneHop

GetTasks

Search LookupValues

SearchHmQuery

SearchMatch

SearchQuery

Use the SortCriteria parameter when using the preceding APIs to ensure the records are not returned in a random order. When the DisablePaging parameter for the preceding APIs is set to the default of

false

, a search token is returned.

You must use the search token within a limited period of time after you receive it. The default time limit for search token validity is 15 minutes. To learn more about changing this limit, contact Informatica Global Customer Support.

Required Parameters

The following table lists and describes the parameters that are required by the GetSearchResults request:

Parameter	Description
SearchToken	Identifies which search to return additional results for.
RecordsToReturn	The number of records to return.
FirstRecord	The index of the first record to return. This parameter is useful for returning subsequent pages of results. For example, if RecordsToReturn= 20 and FirstRecord= 41 , the third page of results is returned (records 41 to 60). GetSearchResults returns an error if the value of FirstRecord is 0, a negative value, or greater than the number of records returned by the original search query.

Optional Parameters

The

GetSearchResults

request does not have optional parameters.

Response Fields

The

GetSearchResults

response contains an array list of the records specified by the required parameters.

Use Case

This is the common scenario for using the GetSearchResults request:

Fetch the next page of a set of records returned from a request that returns multiple pages. After using any request that returns the first of multiple pages of a set of records, you can use

getSearchResults

repeatedly to get the subsequent pages.

GetSearchResults Request Usage Example

The following example requests the second page of data from a search. Ten records are displayed per page:

...
SearchQueryResponse sqResponse = (SearchQueryResponse) 
sipClient.process(request);
String searchToken = sqResponse.getSearchToken();

GetSearchResultsRequest request = new GetSearchResultsRequest();
request.setSearchToken(searchToken);
request.setRecordsToReturn(10);
request.setFirstRecord(11); 
GetSearchResultsResponse response = (GetSearchResultsResponse) sipClient.process(request);

GetSearchResults Response Usage Example

The code in the following example shows how to print out the records returned by the

GetSearchResults

response:

GetSearchResultsResponse response = new GetSearchResultsResponse(); 
int i=0; 
for(Iterator iter=response.getRecords().iterator(); iter.hasNext();) 
{ //iterate through response records 
 System.out.println("Printing response record " + i); 
 Record record = (Record) iter.next(); 
 Collection fields = record.getFields(); 
 for(Iterator fieldIter=fields.iterator(); fieldIter.hasNext();)
{ //iterate through rest of fields 
 Field f = (Field) fieldIter.next(); 
 System.out.println(f.getName() + ": " + f.getValue()); 
 } 
}