com.sap.businessobjects.platform.search.common
Class SearchIndexResponse

java.lang.Object
  DefaultPlatformSearchResponse
      com.sap.businessobjects.platform.search.common.SearchIndexResponse

public class SearchIndexResponse
extends DefaultPlatformSearchResponse

The SearchIndexResponse class provides the response to the search query.

Constructor Summary

SearchIndexResponse()

Method Summary

void	fromXML(XmlPullParser parser) Internal use only.
PropertyBag	getCategoryBag() Retrieves the category information for the response object.
java.lang.String	getContent() Internal use only.
java.lang.String	getDataSearchContent() Internal use only.
int	getEstimatedPages() Internal use only.
IInfoObjects	getHitObjects() Retrieves information about the matching documents from the response object.
java.util.ArrayList	getInfoBlocks()
IInfoObjects	getPolestarObjects() Internal use only.
java.lang.String	getSearchLocale() Internal use only.
PropertyBag	getSuggestionBag() Retrieves suggestions if the search request does not fetch any documents in the search result.
int	getTotalDocCount() Retrieves the cumulative count of all the documents that are returned as part of the results for a specific search query.
int	getTotalInstCount() Retrieves the cumulative count of the instances of the corresponding documents that are displayed as a part of the result for a specific search query.
IInfoObjects	getUniverseObjects() Retrieves info objects representing Universes that contain objects which match the search keyword.
void	setContent(java.lang.String contentSearchContent) Internal use only.
void	setDataSearchContent(java.lang.String dataSearchContent) Internal use only.
void	toXML(XmlSerializer serializer) Internal use only.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchIndexResponse

public SearchIndexResponse()

Method Detail

fromXML

public void fromXML(XmlPullParser parser)
             throws java.lang.Exception

Internal use only.

Throws:

java.lang.Exception

toXML

public void toXML(XmlSerializer serializer)
           throws java.lang.Exception

Internal use only.

Throws:

java.lang.Exception

setContent

public void setContent(java.lang.String contentSearchContent)

Internal use only.

getDataSearchContent

public java.lang.String getDataSearchContent()

Internal use only.

setDataSearchContent

public void setDataSearchContent(java.lang.String dataSearchContent)

Internal use only.

getContent

public java.lang.String getContent()

Internal use only.

getCategoryBag

public PropertyBag getCategoryBag()

Retrieves the category information for the response object.

Returns:

categoryBag The category information.

getEstimatedPages

public int getEstimatedPages()

Internal use only.

getTotalDocCount

public int getTotalDocCount()

Retrieves the cumulative count of all the documents that are returned as part of the results for a specific search query.

Returns:

docsCount The total number of documents in the search result.

getTotalInstCount

public int getTotalInstCount()

Retrieves the cumulative count of the instances of the corresponding documents that are displayed as a part of the result for a specific search query.

Returns:

instCount Total instance of the document count.

getSuggestionBag

public PropertyBag getSuggestionBag()

Retrieves suggestions if the search request does not fetch any documents in the search result.

Returns:

suggestionBag The PropertyBag object that defines the suggestions for the search keyword.

getHitObjects

public IInfoObjects getHitObjects()

Retrieves information about the matching documents from the response object. Information such as document Title, Description, Id, Kind, Updated Timestamp etc. are retrieved. The info objects are sorted by relevance, the first document being the most relevant.

Returns:

hitObjects The IInfoObjects object that retrieves the information regarding the info objects.

getPolestarObjects

public IInfoObjects getPolestarObjects()

Internal use only.

getUniverseObjects

public IInfoObjects getUniverseObjects()

Retrieves info objects representing Universes that contain objects which match the search keyword.

Returns:

universeObjects The IInfoObjects object that retrieves the Universes which contain the search keyword.

getSearchLocale

public java.lang.String getSearchLocale()

Internal use only.

getInfoBlocks

public java.util.ArrayList getInfoBlocks()

Returns:

Returns infoblocks