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

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

public class InfoBlocksRetrieveRequest
extends SearchIndexRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.sap.businessobjects.platform.search.common.SearchIndexRequest

SearchIndexRequest.CategoryTypes, SearchIndexRequest.Qualifiers

Constructor Summary

InfoBlocksRetrieveRequest()

Method Summary

void	fromXML(XmlPullParser parser) from XML Processing
void	fromXMLPage(XmlPullParser parser) Internal use only.
void	fromXMLQuery(XmlPullParser parser, int event) Internal use only.
java.util.Locale	getClientLocale() Deprecated. Search locale will be indexing locale
IEnterpriseSession	getClientSession() Gets the client session
int	getDataRowSize()
static DataSearchProtocolConstants.DataType	getDataTypeFromOrdinal(int ordinal)
InfoBlock	getInfoblock()
int	getMaxCategoriesShown() Internal use only.
int	getMaxInfoBlocks()
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.
InfoBlockMetadata	parseInfoBlockMetadata(XmlPullParser xpp) Parses the Info Block Metadata
void	parseInfoBlocks(XmlPullParser xpp) Parses the info blocks
void	setClientLocale(java.util.Locale loc) Deprecated. Search locale will be indexing locale
void	setDataRowSize(int dataRowSize) sets the data row size
void	setInfoblock(InfoBlock infoblock) Sets the infoblock reference to the specified parameter
void	setLogonToken(java.lang.String ltoken) sets the logon token
void	setMaxCategoriesShown(int categories) This method is used to set the maximum number of categories displayed in a search result.
void	setMaxInfoBlocks(int maxInfoBlocks)
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	toXML(XmlSerializer serializer) Serializes Data to XML file
void	toXMLQuery(XmlSerializer serializer) Internal use only.
void	toXMLRange(XmlSerializer serializer) Internal use only.
void	validateRequest() Internal use only.
void	writeInfoBlockMetadata(InfoBlockMetadata metadata, XmlSerializer xs) Writes the info block metadata

Methods inherited from class com.sap.businessobjects.platform.search.common.SearchIndexRequest

addQualifier, getCategories, getCategoryTypes, getMaxDocuments, getMaxHitLinks, getMaxInstances, getSearchAgents, isCategoryInfoEnabled, isGroupFacetsByType, isGroupInstancesUnderParent, isHighLightingInfoEnabled, isHitLinksEnabled, isHitPromptsEnabled, isSuggestedQueriesEnabled, qualifiers, setCategories, setCategoryInfoEnabled, setCategoryTypes, setGroupFacetsByType, setGroupInstancesUnderParent, setHighLightingInfoEnabled, setHitLinksEnabled, setHitPromptsEnabled, setMaxDocuments, setMaxHitLinks, setMaxInstances, setSearchAgents, setSuggestedQueriesEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

InfoBlocksRetrieveRequest

public InfoBlocksRetrieveRequest()

Method Detail

getInfoblock

public InfoBlock getInfoblock()

Returns:

returns the infoblock

setInfoblock

public void setInfoblock(InfoBlock infoblock)

Sets the infoblock reference to the specified parameter

Parameters:

infoblock -

getClientSession

public IEnterpriseSession getClientSession()
                                    throws SDKException

Gets the client session

Throws:

SDKException

getDataRowSize

public int getDataRowSize()

Returns:

gets the data row size

setDataRowSize

public void setDataRowSize(int dataRowSize)

sets the data row size

Parameters:

dataRowSize -

fromXML

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

from XML Processing

Overrides:

fromXML in class SearchIndexRequest

Throws:

java.lang.Exception

parseInfoBlocks

public void parseInfoBlocks(XmlPullParser xpp)
                     throws java.lang.Exception

Parses the info blocks

Parameters:

xpp -

Throws:

java.lang.Exception

parseInfoBlockMetadata

public InfoBlockMetadata parseInfoBlockMetadata(XmlPullParser xpp)
                                         throws java.lang.Exception

Parses the Info Block Metadata

Parameters:

xpp -

Returns:

Throws:

java.lang.Exception

getDataTypeFromOrdinal

public static DataSearchProtocolConstants.DataType getDataTypeFromOrdinal(int ordinal)

Parameters:

ordinal -

Returns:

Gets the Data Type from Ordinal

toXML

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

Serializes Data to XML file

Overrides:

toXML in class SearchIndexRequest

Throws:

java.lang.Exception

writeInfoBlockMetadata

public void writeInfoBlockMetadata(InfoBlockMetadata metadata,
                                   XmlSerializer xs)
                            throws java.lang.Exception

Writes the info block metadata

Parameters:

metadata -

xs -

Throws:

java.lang.Exception

setLogonToken

public void setLogonToken(java.lang.String ltoken)

sets the logon token

setClientLocale

@Deprecated
public void setClientLocale(java.util.Locale loc)

Deprecated. Search locale will be indexing locale

getClientLocale

@Deprecated
public java.util.Locale getClientLocale()

Deprecated. Search locale will be indexing locale

getSearchAgent

public java.lang.String getSearchAgent()

Description copied from class: SearchIndexRequest

Internal use only.

Overrides:

getSearchAgent in class SearchIndexRequest

Returns:

returns search agent

validateRequest

public void validateRequest()

Internal use only.

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

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.