com.businessobjects.dsws.reportengine
Class Report

java.lang.Object
  com.businessobjects.dsws.reportengine.Report

All Implemented Interfaces:

java.io.Serializable

public class Report

extends java.lang.Object

implements java.io.Serializable

The Report object holds information about a report contained in a document.
An array of the reports contained in a document is retrieved using DocumentInformation.getReports()

Example: Retrieving the Report list.

 RetrieveReportList reportList = new RetrieveReportList();
 RetrieveData retBOData = new RetrieveData();
 RetrieveView retBOView = new RetrieveView();
 retBOData.setRetrieveView(retBOView);
 retBOData.setRetrieveReportList(reportList);
 DocumentInformation docInfo = boReportEngine.getDocumentInformation(strdocID, null, null, null, retBOData);
 Report[] reports= docInfo.getReports();
 for(int i=0;i< reports.length;i++)
 {
   Report report = reports[i];
   String reportName= report.getName();
   String reportID= report.getID();
 }
 

See Also:

RetrieveView, RetrieveData, PromptInfo, Action, FillPrompts, FillPrompt, PromptValue, RangePromptValue, ReportEngine, DocumentInformation, Serialized Form

Constructor Summary

Report()
Instantiate a new blank Report object.

Method Summary

boolean	equals(java.lang.Object obj) Internal Use Only.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
java.lang.String	getID() Return the report ID.
java.lang.String	getName() Return the name of the report.
java.lang.String	getPath() Return the Report path.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
static org.apache.axis.description.TypeDesc	getTypeDesc() Internal Use Only.
int	hashCode() Internal Use Only.
boolean	isDrillActive() Return true if drilling is active.
void	setDrillActive(boolean drillActive) Internal Use Only.
void	setID(java.lang.String ID) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setPath(java.lang.String path) Internal Use Only.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Report

public Report()

Instantiate a new blank Report object.

Method Detail

getName

public java.lang.String getName()

Return the name of the report.

Returns:

the name of the report

setName

public void setName(java.lang.String name)

Internal Use Only.

getID

public java.lang.String getID()

Return the report ID.

Returns:

the report ID.

setID

public void setID(java.lang.String ID)

Internal Use Only.

getPath

public java.lang.String getPath()

Return the Report path.

Returns:

the Report path.

setPath

public void setPath(java.lang.String path)

Internal Use Only.

isDrillActive

public boolean isDrillActive()

Return true if drilling is active. There are two possible report modes: viewing and analysis. When the report mode is set to viewing, certain features, such as drilling, are not enabled. If isDrillActive is true, the current report mode is analysis and, as such, drilling is enabled. If isDrillActive is false, the current report mode is viewing and, as such, drilling is disabled.

Returns:

true if the report mode is currently analysis.

setDrillActive

public void setDrillActive(boolean drillActive)

Internal Use Only.

equals

public boolean equals(java.lang.Object obj)

Internal Use Only.

hashCode

public int hashCode()

Internal Use Only.

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Internal Use Only.

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Internal Use Only.

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Internal Use Only.