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

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

public class CreateDocumentRequest
extends DefaultPlatformSearchRequest

The CreateDocumentRequest class provides the parameters to create an Interactive Analysis document. The CreateDocumentRequest is passed to the Platform Search Service. The Platform Search Service uses the request parameters to create the document using the universe objects and filters which are returned as a part of the Universe object hits.

Constructor Summary

CreateDocumentRequest()

Method Summary

void	addFilter(java.lang.String objectName, java.lang.String[] values) This method accepts the filter name and values that you want to apply to the Interactive Analysis document.
void	addResultObjectName(java.lang.String name) This method accepts the name of the Universe object that you want to view in an Interactive Analysis document.
void	fromXML(XmlPullParser parser) Internal use only.
boolean	getAutoDrill() Internal use only.
boolean	getAutoRun() Internal use only.
java.util.Vector	getM_filerObjects() Internal use only.
java.util.Vector	getM_filterValuesObjects() Internal use only.
java.util.Vector	getM_resultObjects() Internal use only.
java.lang.String	getSearchAgent() Internal use only.
java.lang.String	getTitle() This method retrieves the title specified for the Interactive Analysis document.
java.lang.String	getUniverseCUID() This method retrieves the Universe CUID used to create an Interactive Analysis document.
void	setAutoDrill(boolean value) This method provides the parameters to enable auto drill option in an Interactive Analysis document.
void	setAutoRun(boolean value) This method provides the parameters to execute the query for the Interactive Analysis document.
void	setM_filerObjects(java.util.Vector objects) Internal use only.
void	setM_filterValuesObjects(java.util.Vector valuesObjects) Internal use only.
void	setM_resultObjects(java.util.Vector objects) Internal use only.
void	setTitle(java.lang.String title) This method defines the parameters to set the title of report created in Interactive Analysis.
void	setUniverseCUID(java.lang.String cuid) This method provides the parameters to define the Universe CUID to be used to create an Interactive Analysis document.
void	toXML(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

CreateDocumentRequest

public CreateDocumentRequest()

Method Detail

setUniverseCUID

public void setUniverseCUID(java.lang.String cuid)

This method provides the parameters to define the Universe CUID to be used to create an Interactive Analysis document.

Parameters:

cuid - A String value to set CUID of the universe.

getUniverseCUID

public java.lang.String getUniverseCUID()

This method retrieves the Universe CUID used to create an Interactive Analysis document.

Returns:

Universe CUID

setTitle

public void setTitle(java.lang.String title)

This method defines the parameters to set the title of report created in Interactive Analysis.

Parameters:

title - A String value to set the title of report.

getTitle

public java.lang.String getTitle()

This method retrieves the title specified for the Interactive Analysis document.

Returns:

The title of the Interactive Analysis document.

setAutoRun

public void setAutoRun(boolean value)

This method provides the parameters to execute the query for the Interactive Analysis document.

Parameters:

value - A boolean value to execute the query for the Interactive Analysis document.

getAutoRun

public boolean getAutoRun()

Internal use only.

setAutoDrill

public void setAutoDrill(boolean value)

This method provides the parameters to enable auto drill option in an Interactive Analysis document.

Parameters:

value - A boolean value to enable auto drill in an Interactive Analysis document.

getAutoDrill

public boolean getAutoDrill()

Internal use only.

addResultObjectName

public void addResultObjectName(java.lang.String name)

This method accepts the name of the Universe object that you want to view in an Interactive Analysis document. These Universe object names are returned as a part of the Universe Hit response retrieved from the search results.

Parameters:

name - A String value of Universe object that you want to view in an Interactive Analysis document.

addFilter

public void addFilter(java.lang.String objectName,
                      java.lang.String[] values)

This method accepts the filter name and values that you want to apply to the Interactive Analysis document. These filters are returned as a part of the Universe Hit response retrieve from search results.

Parameters:

objectName - A String value for the filterName used in an Interactive Analysis document.

values - An array of strings to specify the values for the specified filterName.

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

getM_resultObjects

public java.util.Vector getM_resultObjects()

Internal use only.

setM_resultObjects

public void setM_resultObjects(java.util.Vector objects)

Internal use only.

getM_filerObjects

public java.util.Vector getM_filerObjects()

Internal use only.

setM_filerObjects

public void setM_filerObjects(java.util.Vector objects)

Internal use only.

getM_filterValuesObjects

public java.util.Vector getM_filterValuesObjects()

Internal use only.

setM_filterValuesObjects

public void setM_filterValuesObjects(java.util.Vector valuesObjects)

Internal use only.

getSearchAgent

public java.lang.String getSearchAgent()

Internal use only.

validateRequest

public void validateRequest()

Internal use only.