com.sap.businessobjects.platform.search
Interface IPlatformSearchService

public interface IPlatformSearchService

The IPlatformSearchService interface provides the methods used to perform search and create an Interactive Analysis document.

Method Summary

CreateDocumentResponse	createDocument(CreateDocumentRequest request) This method is used to create an Interactive Analysis document.
DataSearchResult	dataSearch(InfoBlocksRetrieveRequest request)
SearchIndexResponse	fullSearch(java.lang.String queryString, java.util.Locale clientLocale) This method is used for retrieving search results.
ValidateIndexLocationResponse	isLocationValid(java.lang.String location)
SearchIndexResponse	quickSearch(java.lang.String queryString, java.util.Locale clientLocale, int maxInstances, int page, int pageSize, java.lang.String[] categories) This method is used for retrieving search results.
SearchIndexResponse	search(SearchIndexRequest request) This method is used for retrieving search results using SearchIndexRequest as input.

Method Detail

search

SearchIndexResponse search(SearchIndexRequest request)
                           throws java.lang.Exception

This method is used for retrieving search results using SearchIndexRequest as input.

Parameters:

request - A SearchIndexRequest which provides parameters to define a search request.

Throws:

java.lang.Exception

dataSearch

DataSearchResult dataSearch(InfoBlocksRetrieveRequest request)
                            throws java.lang.Exception

Throws:

java.lang.Exception

createDocument

CreateDocumentResponse createDocument(CreateDocumentRequest request)
                                      throws java.lang.Exception

This method is used to create an Interactive Analysis document.

Parameters:

request - A CreateDocumentRequest which provides parameters to create an Interactive Analysis document.

Throws:

java.lang.Exception

fullSearch

SearchIndexResponse fullSearch(java.lang.String queryString,
                               java.util.Locale clientLocale)
                               throws java.lang.Exception

This method is used for retrieving search results. It internally creates a search request and sets all parameters as true.

Parameters:

queryString - A String value for search query.

clientLocale - A Locale value for the search request.

Throws:

java.lang.Exception

quickSearch

SearchIndexResponse quickSearch(java.lang.String queryString,
                                java.util.Locale clientLocale,
                                int maxInstances,
                                int page,
                                int pageSize,
                                java.lang.String[] categories)
                                throws java.lang.Exception

This method is used for retrieving search results. It internally creates search request using the input parameter.

Parameters:

queryString - A String value to set the search string for search request.

clientLocale - A Locale value to the locale for the given search request.

maxInstances - A int value to set the number of instances that must be returned in the search result.

page - An int value to set the page number for the given search result.

pageSize - An int value to set the page-size for the given search result.

categories - An array of strings to specify the parameters based on which you want to search for infoobjects.

Throws:

java.lang.Exception

isLocationValid

ValidateIndexLocationResponse isLocationValid(java.lang.String location)