com.businessobjects.rebean.wi
Interface DrillInfo

public interface DrillInfo

The DrillInfo interface provides access to analysis (drill) features. This is a dynamic interface, so this interface is implemented by report engines which support the drill operations.

DrillOption, and DrillPath contains information about the requested drill operation. You can use DrillBar to access the drill bar feature which enables users to apply filters.

See Also:

DrillOption, DrillPath, DrillBar

Method Summary

DrillElements	addQueryConditions() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
Report	beginDrill() Begins the drill operation (analysis mode).
void	endDrill() Ends the drill operations.
void	executeDrill() Executes the specified drill operation.
DrillElements	extendScopeOfAnalysis() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
java.lang.String	getActiveBlockID() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
DrillHierarchies	getContainingHierarchies(java.lang.String dimensionID) Returns the drill hierarchies that contain a specified dimension.
DrillBar	getDrillBar() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
DrillBlock	getDrillBlock(java.lang.String BlockID) Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
DrillHierarchies	getDrillHierarchies() Returns the drill hierarchies defined by the objects of the query.
DrillOption	getDrillOption() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
DrillPath	getDrillPath() Returns the drill path for the drill operation.
DrillDetails	getFreeDrillDetails() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
DrillDimensions	getFreeDrillDimensions() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
boolean	isActive() Tests if the current report is in drill mode.
DrillElements	removeQueryConditions() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
void	setDrillOption(DrillOption option) Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
Report	snapshot() Warning: This method is no longer functional from the SAP BusinessObjects 4.0 release onwards.
boolean	willGoOutOfScope() Tests if the user has included a dimension drill operation outside of the query's scope.

Method Detail

isActive

boolean isActive()

Tests if the current report is in drill mode.

Returns:

true if the report is in drill mode; false otherwise.

willGoOutOfScope

boolean willGoOutOfScope()
                         throws REException

Tests if the user has included a dimension drill operation outside of the query's scope. You can also use DrillDimension.isInScope to test if a dimension is out of scope.

Throws:

REException

See Also:

DrillDimension.isInScope()

getActiveBlockID

java.lang.String getActiveBlockID()

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

Returns the ID of the block on which the drill operation is being performed.

Returns:

the ID of the block for the drill operation.

getDrillOption

DrillOption getDrillOption()

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

Returns the drill options for the report.

Returns:

the report's drill options.

See Also:

DrillOption

setDrillOption

void setDrillOption(DrillOption option)

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

Sets the report's drill option.

Parameters:

option - the drill options for the report.

getDrillPath

DrillPath getDrillPath()

Returns the drill path for the drill operation.

Returns:

the current drill path.

See Also:

DrillPath

getDrillBlock

DrillBlock getDrillBlock(java.lang.String BlockID)
                         throws REException

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

Returns the drill block for the drill operation.

Parameters:

BlockID - the ID of the block.

Returns:

the drill block for the drill operation.

Throws:

REException

See Also:

DrillBlock

getDrillBar

DrillBar getDrillBar()
                     throws REException

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

Returns the drill bar for the drill operation.

Returns:

the drill bar for the drill operation

Throws:

REException

See Also:

DrillBar

getDrillHierarchies

DrillHierarchies getDrillHierarchies()
                                     throws REException

Returns the drill hierarchies defined by the objects of the query.

Returns:

the hierarchies defined in the query

Throws:

REException

getContainingHierarchies

DrillHierarchies getContainingHierarchies(java.lang.String dimensionID)
                                          throws REException

Returns the drill hierarchies that contain a specified dimension.

Parameters:

dimensionID - the ID of the dimension.

Returns:

the hierarchies that contain the specified dimension.

Throws:

REException

See Also:

DrillHierarchies

getFreeDrillDimensions

DrillDimensions getFreeDrillDimensions()
                                       throws REException

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

Gets the free drill dimensions.

A free dimension is one that does not belong to a hierarchy.

Returns:

a collection of the free dimensions

Throws:

REException

See Also:

DrillInfo.getFreeDrillDetails(), DrillDimensions

getFreeDrillDetails

DrillDetails getFreeDrillDetails()
                                 throws REException

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

Gets the free drill details.

A free detail is one that doesn't belong to a dimension.

Returns:

a collection of the free details

Throws:

REException

See Also:

DrillInfo.getFreeDrillDimensions(), DrillDetails

beginDrill

Report beginDrill()
                  throws REException

Begins the drill operation (analysis mode).

This method returns a report depending on the user's settings. If the user profile setting CADENZA_DuplicateReportDrill is "true", a duplicate instance of the report is returned. Note that the display of the duplicate report can be different from the original.

Returns:

a duplicate report in which to perform the drill

Throws:

REException

See Also:

DrillInfo.endDrill()

addQueryConditions

DrillElements addQueryConditions()

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

Adds conditions to the drill.

This method returns a collection of DrillElements to which you add the dimensions (DrillFromElement) to be used to create conditions on the query.

See Also:

DrillInfo.removeQueryConditions(), DrillElements

removeQueryConditions

DrillElements removeQueryConditions()

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

Removes conditions from the drill.

This method returns a collection of DrillElements to which you add the dimensions (DrillFromElement) to be removed from the query's conditions.

See Also:

DrillInfo.addQueryConditions(), DrillElements

endDrill

void endDrill()
              throws REException

Ends the drill operations.

Throws:

REException

See Also:

DrillInfo.beginDrill()

executeDrill

void executeDrill()
                  throws REException

Executes the specified drill operation.

A drill operation is:

• a normal drill operation with to-elements, from-elements and a drill action
• a filter operation, for example a filter applied in the drill bar

Throws:

REException

extendScopeOfAnalysis

DrillElements extendScopeOfAnalysis()

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

Extends the scope of analysis to include other dimensions.

This method returns a DrillElements object to which you add the extra dimensions that are to be included in the scope of analysis.

See Also:

DrillElements

snapshot

Report snapshot()
                throws REException

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

Creates a duplicate report based on a snapshot of the current report's display.

You need to refresh the report map to make sure the new report is displayed.

Throws:

REException

See Also:

Report, ReportMap