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

java.lang.Object
  com.sap.businessobjects.platform.search.common.DataSearchResult
      com.sap.businessobjects.platform.search.common.InfoBlockRetrieveResponse

public class InfoBlockRetrieveResponse
extends DataSearchResult

Represents the Info Block Retrieve Response

Field Summary

static int	DEFAULT_MAX_VALUES Default Maximum Values
static java.lang.String	NAMESPACE Name space
static java.lang.String	RESPONSE Response
static java.lang.String	RESPONSE_CLASS Respnonse Class
static java.lang.String	RESULT Result

Fields inherited from class com.sap.businessobjects.platform.search.common.DataSearchResult

CONTENT

Constructor Summary

InfoBlockRetrieveResponse()

Method Summary

void	fromXML(XmlPullParser parser) from XML Processing
InfoBlock	getBlock()
static DataSearchProtocolConstants.DataType	getDataTypeFromOrdinal(int ordinal) Gets the Data type from ordinal for the data search protocol constant
java.lang.String	getSearchLocale()
void	parseInfoBlock(XmlPullParser xpp) Parses the infoblock
IRowSet	parseInfoBlockData(XmlPullParser xpp) Parses the info block data
InfoBlockMetadata	parseInfoBlockMetadata(XmlPullParser xpp) Parses the info block metadata
void	setBlock(InfoBlock block) sets the value of block
void	setPluginMgr(IPluginMgr pluginMgr) Sets the plugin Manager
void	setSession(ISecuritySession session) Sets the Session
void	toXML(XmlSerializer serializer) Serializes data to XML file
void	writeInfoBlock(XmlSerializer serializer)
void	writeInfoBlockData(IRowSet rowset, XmlSerializer xs, InfoBlockMetadata metadata) Writes the InfoBlockMetaData
void	writeInfoBlockMetadata(InfoBlockMetadata metadata, XmlSerializer xs)

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

getInfoBlocks, getOutputType, getSearchType, parseInfoBlocks, setInfoBlocks, setOutputType, setSearchType, writeInfoBlock, writeInfoBlocks

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

Name space

See Also:

Constant Field Values

RESPONSE

public static java.lang.String RESPONSE

Response

RESULT

public static java.lang.String RESULT

Result

RESPONSE_CLASS

public static java.lang.String RESPONSE_CLASS

Respnonse Class

DEFAULT_MAX_VALUES

public static final int DEFAULT_MAX_VALUES

Default Maximum Values

See Also:

Constant Field Values

Constructor Detail

InfoBlockRetrieveResponse

public InfoBlockRetrieveResponse()

Method Detail

getBlock

public InfoBlock getBlock()

Returns:

returns info block

setBlock

public void setBlock(InfoBlock block)

sets the value of block

Parameters:

block -

getSearchLocale

public java.lang.String getSearchLocale()

Overrides:

getSearchLocale in class DataSearchResult

Returns:

returns search Locale

setSession

public void setSession(ISecuritySession session)

Sets the Session

Overrides:

setSession in class DataSearchResult

Parameters:

session -

setPluginMgr

public void setPluginMgr(IPluginMgr pluginMgr)

Sets the plugin Manager

Overrides:

setPluginMgr in class DataSearchResult

Parameters:

pluginMgr -

toXML

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

Serializes data to XML file

Overrides:

toXML in class DataSearchResult

Throws:

java.lang.Exception

writeInfoBlock

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

Throws:

java.lang.Exception

writeInfoBlockData

public void writeInfoBlockData(IRowSet rowset,
                               XmlSerializer xs,
                               InfoBlockMetadata metadata)
                        throws java.lang.Exception

Writes the InfoBlockMetaData

Parameters:

rowset -

xs -

metadata -

Throws:

java.lang.Exception

writeInfoBlockMetadata

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

Throws:

java.lang.Exception

fromXML

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

from XML Processing

Overrides:

fromXML in class DataSearchResult

Throws:

java.lang.Exception

parseInfoBlock

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

Parses the infoblock

Parameters:

xpp -

Throws:

java.lang.Exception

parseInfoBlockMetadata

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

Parses the info block metadata

Throws:

java.lang.Exception

parseInfoBlockData

public IRowSet parseInfoBlockData(XmlPullParser xpp)
                           throws java.lang.Exception

Parses the info block data

Parameters:

xpp -

Returns:

Throws:

java.lang.Exception

getDataTypeFromOrdinal

public static DataSearchProtocolConstants.DataType getDataTypeFromOrdinal(int ordinal)

Gets the Data type from ordinal for the data search protocol constant