com.businessobjects.rebean.wi
Interface Report

All Superinterfaces:

Dynamic

public interface Report
extends Dynamic

The Report interface provides access to the report information.

This interface extends the Dynamic interface. Some interfaces will be aggregated at run time.

Method Summary

BlockInfo	getBlockInfo() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
java.lang.String	getID() Gets the report ID.
java.lang.String	getName() Gets the report name.
boolean	getOutlineMode() Warning:This interface is no longer functional from the SAP BusinessObjects XI 4.0 release onwards.
PageNavigation	getPageNavigation() Gets the PageNavigation object associated to this Report.
PaginationMode	getPaginationMode() Gets the report PaginationMode.
java.lang.String	getPath() Returns the current position within a report.
ReportMode	getReportMode() Gets the report mode.
java.lang.String	getSourceName() Warning:This interface is no longer functional from the SAP BusinessObjects XI 4.0 release onwards.
TrackDataInfo	getTrackDataInfo() Gets the TrackDataInfo interface which gives access to the track Data Feature for a Report.
java.lang.Object	getView(OutputFormatType outputFormat) Gets the view for a specific OutputFormatType.
java.lang.Object	getView(OutputFormatType outputFormat, java.util.Properties properties) Gets the view for a specific OutputFormatType and Properties.
java.lang.Object	getXMLView(int filter) Returns an XML view of the Report.
java.lang.Object	getXMLView(int filter, java.util.Properties properties) Returns an XML view of the Report.
void	setOutlineMode(boolean outlineMode) Warning:This interface is no longer functional from the SAP BusinessObjects XI 4.0 release onwards.
void	setPaginationMode(PaginationMode paginationMode) Sets the report PaginationMode.
void	setReportMode(ReportMode reportMode) Deprecated. This method was used as a workaround for a known problem in Business Objects XI and should no longer be called. Since version 11.5, calling this method has no result.

Methods inherited from interface com.businessobjects.rebean.wi.Dynamic

getNamedInterface, getNamedInterfaces

Method Detail

getName

java.lang.String getName()

Gets the report name.

Returns:

The name of the report.

getSourceName

java.lang.String getSourceName()

Warning:This interface is no longer functional from the SAP BusinessObjects XI 4.0 release onwards.

Returns the name of the report in the locale it was created.

Returns:

The name of the report in the locale it was created.

Since:

12.2

getID

java.lang.String getID()

Gets the report ID.

Returns:

The report ID.

getReportMode

ReportMode getReportMode()

Gets the report mode.

Possible report modes are:

• Viewing
• Analysis

The Analysis ReportMode is activated during the drill operations.

Returns:

ReportMode The current ReportMode.

setReportMode

@Deprecated
void setReportMode(ReportMode reportMode)

Deprecated. This method was used as a workaround for a known problem in Business Objects XI and should no longer be called. Since version 11.5, calling this method has no result.

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Sets the ReportMode in which the report is to be viewed.

• Viewing
• Analysis

The ReportMode.Analysis mode is activated during drill operations.

Parameters:

reportMode - The ReportMode in which the report is to be viewed.

Since:

11.5

setPaginationMode

void setPaginationMode(PaginationMode paginationMode)

Sets the report PaginationMode.

Possible PaginationMode are:

• Listing
• Page

Parameters:

paginationMode - The PaginationMode to be applied to the Report.

getPaginationMode

PaginationMode getPaginationMode()

Gets the report PaginationMode. Possible values are:

• Listing
• Page

Returns:

The current PaginationMode.

See Also:

PaginationMode

getPath

java.lang.String getPath()

Returns the current position within a report. A path is an unique identifier set using DocumentInstance.setPath, which points to a specific document location.

If a report's path is set, the document is opened to the page containing the section specified in the path.

The path completely independent of pagination.

A path is a concatenation of report index a slash followed by section indexes separated by semicolons.

Example: 0/0;0 means 1st report, 1st section, 1st sub section

Example: The paths in a document containing two reports, each report contains sections.

Report Name	Section Name			Path
Report1				0
	USA			0/0
		NY		0/0;0
			Morgan S	0/0;0;0
			Bank of NY	0/0;0;1
		SJ		0/0;1
			Bank of CA	0/0;1;0
	FR			0/1
		Levallois		0/1;0
		Paris		0/1;1
Report2				1
	Jan			1/0
	Feb			1/1
		week2		1/1;0

Returns:

the current position in a document.

See Also:

DocumentInstance.setPath(java.lang.String)

getPageNavigation

PageNavigation getPageNavigation()

Gets the PageNavigation object associated to this Report. This PageNavigation object returns defines the way in which a user navigates through a report.

Returns:

The PageNavigation object for this Report.

getBlockInfo

BlockInfo getBlockInfo()

Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.

Gets the BlockInfo object associated to this report.

Use the returned BlockInfo object to access to all Blocks contained in the Report.

Returns:

Gets the BlockInfo object associated to this report.

getView

java.lang.Object getView(OutputFormatType outputFormat)

Gets the view for a specific OutputFormatType.

Parameters:

outputFormat - The OutputFormatType required.

Returns:

View The view for a specific OutputFormatType.

getView

java.lang.Object getView(OutputFormatType outputFormat,
                         java.util.Properties properties)
                         throws REException

Gets the view for a specific OutputFormatType and Properties. Media are the parameters that are used to format the document.

You can set the default media properties according to your preferences. You must specify the Media Types as a combination of Name and Value.

Parameters:

outputFormat - the output format.

properties - a set of properties used to customize the output. Use property names from OutputPropertiesType.

Returns:

View The view for a specific OutputFormatType and Properties.

Throws:

REException

Since:

11.7

See Also:

OutputPropertiesType

getXMLView

java.lang.Object getXMLView(int filter)

Returns an XML view of the Report.

The contents of the Report output returned is controlled by the filter. See XMLView for the list of bitfields it is possible to use in the filter parameter. Note: by default, the CONTENT and GRAPH_AS_BINARY bitfields are OR'd together.

Parameters:

filter - A single bitfield or combination of bitfields OR'd together.

Returns:

Since:

11.5

getXMLView

java.lang.Object getXMLView(int filter,
                            java.util.Properties properties)

Returns an XML view of the Report.

The contents of the Report output returned is controlled by the filter and media properties. See XMLView for the list of bitfields it is possible to use in the filter parameter. Note: by default, the CONTENT and GRAPH_AS_BINARY bitfields are OR'd together.

Parameters:

filter - a single bitfield or combination of bitfields OR'd together.

properties - a set of properties used to customize the output.

Returns:

View The view for an XML output.

Since:

11.7

See Also:

OutputPropertiesType

getTrackDataInfo

TrackDataInfo getTrackDataInfo()

Gets the TrackDataInfo interface which gives access to the track Data Feature for a Report. It allows to activate Track data on a Report.

Returns:

the TrackDataInfo Feature interface, otherwise null , if it's not supported.

Since:

12.0

setOutlineMode

void setOutlineMode(boolean outlineMode)

Warning:This interface is no longer functional from the SAP BusinessObjects XI 4.0 release onwards.

Sets the report OutlineMode. to true/false

Parameters:

outlineMode - The OutlineMode to be applied to the Report.

Since:

12.2

getOutlineMode

boolean getOutlineMode()

Warning:This interface is no longer functional from the SAP BusinessObjects XI 4.0 release onwards.

Gets the report OutlineMode. Possible values are:

• true
• false

Returns:

The current OutlineMode.

Since:

12.2