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

java.lang.Object
  DefaultPlatformSearchRequest
      com.sap.businessobjects.platform.search.common.SearchIndexRequest

Direct Known Subclasses:

InfoBlocksRetrieveRequest

public class SearchIndexRequest
extends DefaultPlatformSearchRequest

The SearchIndexRequest class provides the parameters to define a search request. The search request is passed to the Platform Search Service. The Platform Search Service uses the request parameters to search in the indexed area and returns the results to the client.

Nested Class Summary

static class	SearchIndexRequest.CategoryTypes The CategoryTypes is an enum to define different category types.
class	SearchIndexRequest.Qualifiers Internal use only.

Constructor Summary

SearchIndexRequest()
Constructor.

Method Summary

void	addQualifier(java.lang.String property, java.lang.String value) Internal use only.
void	fromXML(XmlPullParser parser) Internal use only.
void	fromXMLPage(XmlPullParser parser) Internal use only.
void	fromXMLQuery(XmlPullParser parser, int event) Internal use only.
java.lang.String[]	getCategories() Internal use only.
SearchIndexRequest.CategoryTypes[]	getCategoryTypes() Internal use only.
int	getMaxCategoriesShown() Internal use only.
int	getMaxDocuments() Internal use only.
int	getMaxHitLinks() Internal use only.
int	getMaxInfoBlocks()
int	getMaxInstances() Internal use only.
int	getMaxSubCategoriesShown() Internal use only.
int	getPage() Internal use only.
int	getPageSize() Internal use only.
java.lang.String	getQuery() Internal use only.
java.lang.String	getSearchAgent() Internal use only.
java.lang.String[]	getSearchAgents() Internal use only.
boolean	isCategoryInfoEnabled() Internal use only.
boolean	isGroupFacetsByType() Internal use only.
boolean	isGroupInstancesUnderParent() Internal use only.
boolean	isHighLightingInfoEnabled() This method is used to know if the highlighting info is enabled.
boolean	isHitLinksEnabled() Internal use only.
boolean	isHitPromptsEnabled() This method is used to know if the prompt is enabled or not.
boolean	isSuggestedQueriesEnabled() Internal use only.
SearchIndexRequest.Qualifiers	qualifiers() Internal use only.
void	setCategories(java.lang.String[] categories) This method defines a search request to retrieve a particular document from the repository.
void	setCategoryInfoEnabled(boolean categoryInfo) This method determines whether to retrieve categories in the search result.
void	setCategoryTypes(SearchIndexRequest.CategoryTypes[] types) This method is used to specify the Category Types that should be retrieved, i.e.
void	setGroupFacetsByType(boolean groupFacetsByType) This method is used to retrieve all the category values in a single bag or grouped into different bags.
void	setGroupInstancesUnderParent(boolean groupInstancesUnderParent) Internal use only.
void	setHighLightingInfoEnabled(boolean highLightingInfo) This method determines whether to highlight the search keyword in the title, description and keyword that are displayed as part of search results.By default, it is set to true.
void	setHitLinksEnabled(boolean hitLinks) This method determines whether to display the hit links in the search results.
void	setHitPromptsEnabled(boolean hitPrompts) This method determines whether to retrieve prompts in the search results.
void	setMaxCategoriesShown(int categories) This method is used to set the maximum number of categories displayed in a search result.
void	setMaxDocuments(int maxDocuments) This method is used to control the number of hits to be returned as part of the search request.
void	setMaxHitLinks(int maxHitLinks) This method is used to control the number of hit links returned to the user.
void	setMaxInfoBlocks(int maxInfoBlocks)
void	setMaxInstances(int maxInstances) This method specifies the number of instances that must be returned in the search result.
void	setMaxSubCategoriesShown(int subcategories) This method is used to set the maximum number of sub-object categories displayed in a search result.
void	setPage(int page) This method is used to set the page number of a search request that you want to retrieve.
void	setPageSize(int pageSize) This method is used to set the number of objects you want to display in a given page.
void	setQuery(java.lang.String queryString) This method is used to set the search string.
void	setSearchAgents(java.lang.String[] searchAgents) This method allows you to integrate other search engines server, such as Polestar, with the BOE server.
void	setSuggestedQueriesEnabled(boolean suggestedQueries) This method determines whether to display suggested queries in the search result.
void	toXML(XmlSerializer serializer) Internal use only.
void	toXMLQuery(XmlSerializer serializer) Internal use only.
void	toXMLRange(XmlSerializer serializer) Internal use only.
void	validateRequest() Internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchIndexRequest

public SearchIndexRequest()

Constructor.

Method Detail

getSearchAgent

public java.lang.String getSearchAgent()

Internal use only.

setCategories

public void setCategories(java.lang.String[] categories)

This method defines a search request to retrieve a particular document from the repository. For example, you may want to search for documents that are located in a specific folder or documents that are created by a particular author.

Parameters:

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

getCategories

public java.lang.String[] getCategories()

Internal use only.

getCategoryTypes

public SearchIndexRequest.CategoryTypes[] getCategoryTypes()

Internal use only.

setCategoryTypes

public void setCategoryTypes(SearchIndexRequest.CategoryTypes[] types)

This method is used to specify the Category Types that should be retrieved, i.e. Metadata, Content and/or All categories.

Parameters:

types - An array of the CategoryTypes enumeration to specify the category types you want to search for.

isGroupFacetsByType

public boolean isGroupFacetsByType()

Internal use only.

setGroupFacetsByType

public void setGroupFacetsByType(boolean groupFacetsByType)

This method is used to retrieve all the category values in a single bag or grouped into different bags.

Parameters:

groupFacetsByType - A boolean value to enable or disable the grouping.

addQualifier

public void addQualifier(java.lang.String property,
                         java.lang.String value)

Internal use only.

qualifiers

public SearchIndexRequest.Qualifiers qualifiers()

Internal use only.

getMaxInstances

public int getMaxInstances()

Internal use only.

setMaxInstances

public void setMaxInstances(int maxInstances)

This method specifies the number of instances that must be returned in the search result. This is useful if there are more than one instance of a document that is being searched.

Parameters:

maxInstances - An int value to specify the number of instances.

isGroupInstancesUnderParent

public boolean isGroupInstancesUnderParent()

Internal use only.

setGroupInstancesUnderParent

public void setGroupInstancesUnderParent(boolean groupInstancesUnderParent)

Internal use only.

getMaxHitLinks

public int getMaxHitLinks()

Internal use only.

setMaxHitLinks

public void setMaxHitLinks(int maxHitLinks)

This method is used to control the number of hit links returned to the user. By default the number of hit links sent back will be 1.

Parameters:

maxHitLinks - Number of hit links to be returned.

getMaxDocuments

public int getMaxDocuments()

Internal use only.

setMaxDocuments

public void setMaxDocuments(int maxDocuments)

This method is used to control the number of hits to be returned as part of the search request. The default value is 1000.

Parameters:

maxDocuments - The maximum number of search results to be returned.

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

isHighLightingInfoEnabled

public boolean isHighLightingInfoEnabled()

This method is used to know if the highlighting info is enabled. Returns the boolean value.

Returns:

True if the highlighting info is enabled, false otherwise.

setHighLightingInfoEnabled

public void setHighLightingInfoEnabled(boolean highLightingInfo)

This method determines whether to highlight the search keyword in the title, description and keyword that are displayed as part of search results.By default, it is set to true.

Parameters:

highLightingInfo - A boolean value to enable or disable the highlighting of matched content in the search results.

isHitLinksEnabled

public boolean isHitLinksEnabled()

Internal use only.

setHitLinksEnabled

public void setHitLinksEnabled(boolean hitLinks)

This method determines whether to display the hit links in the search results. By default, it is set to true.

Parameters:

hitLinks - A boolean value to enable or disable the display of hit links in the search result.

isHitPromptsEnabled

public boolean isHitPromptsEnabled()

This method is used to know if the prompt is enabled or not. Returns the boolean value

Returns:

True if the prompt is enabled, false otherwise.

setHitPromptsEnabled

public void setHitPromptsEnabled(boolean hitPrompts)

This method determines whether to retrieve prompts in the search results. Prompts are supported by Crystal Reports, Web Intelligence documents and Desktop Intelligence documents. By default, prompts are displayed in the search result.

Parameters:

hitPrompts - A boolean value to enable or disable the display of prompts in the search result.

isSuggestedQueriesEnabled

public boolean isSuggestedQueriesEnabled()

Internal use only.

setSuggestedQueriesEnabled

public void setSuggestedQueriesEnabled(boolean suggestedQueries)

This method determines whether to display suggested queries in the search result. The suggested queries that are generated based on the search keyword enable you to create new Web Intelligence documents. By default, suggested queries are displayed in the search result.

Parameters:

suggestedQueries - A boolean value to enable or disable the retrieval of suggested queries in the search result.

isCategoryInfoEnabled

public boolean isCategoryInfoEnabled()

Internal use only.

setCategoryInfoEnabled

public void setCategoryInfoEnabled(boolean categoryInfo)

This method determines whether to retrieve categories in the search result. By default, categories are displayed in the search result.

Parameters:

categoryInfo - A boolean value to enable or disable the display of categories in the search result.

getSearchAgents

public java.lang.String[] getSearchAgents()

Internal use only.

setSearchAgents

public void setSearchAgents(java.lang.String[] searchAgents)

This method allows you to integrate other search engines server, such as Polestar, with the BOE server.

Parameters:

searchAgents - A String containing the cuid of the server that has to be integrated.

getMaxInfoBlocks

public int getMaxInfoBlocks()

setMaxInfoBlocks

public void setMaxInfoBlocks(int maxInfoBlocks)

setQuery

public void setQuery(java.lang.String queryString)
              throws PlatformSearchException

This method is used to set the search string.

Parameters:

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

Throws:

PlatformSearchException

getQuery

public java.lang.String getQuery()

Internal use only.

setPageSize

public void setPageSize(int pageSize)

This method is used to set the number of objects you want to display in a given page.

Parameters:

pageSize - A Int value to set the page- size for a search request.

getPageSize

public int getPageSize()

Internal use only.

setPage

public void setPage(int page)

This method is used to set the page number of a search request that you want to retrieve.

Parameters:

page - A int value to set the page number for search request.

getPage

public int getPage()

Internal use only.

fromXMLQuery

public void fromXMLQuery(XmlPullParser parser,
                         int event)
                  throws java.lang.Exception

Internal use only.

Throws:

java.lang.Exception

fromXMLPage

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

Internal use only.

Throws:

java.lang.Exception

toXMLQuery

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

Internal use only.

Throws:

java.lang.Exception

toXMLRange

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

Internal use only.

Throws:

java.lang.Exception

validateRequest

public void validateRequest()

Internal use only.

getMaxCategoriesShown

public int getMaxCategoriesShown()

Internal use only.

setMaxCategoriesShown

public void setMaxCategoriesShown(int categories)

This method is used to set the maximum number of categories displayed in a search result.

Parameters:

categories - An int value to set the maximum number of categories displayed in a search result.

getMaxSubCategoriesShown

public int getMaxSubCategoriesShown()

Internal use only.

setMaxSubCategoriesShown

public void setMaxSubCategoriesShown(int subcategories)

This method is used to set the maximum number of sub-object categories displayed in a search result.

Parameters:

categories - An int value to set the maximum number of sub-object categories displayed in a search result.