com.businessobjects.dsws.reportengine
Interface DrillInfo

public interface DrillInfo

DrillInfo contains the necessary information to perform a drill in a document with the drill activated.

Example: Get the information about the drill.

 RetrieveDrillInfo boDrillInfo = RetrieveDrillInfo.Factory.newInstance();
 boDrillInfo.setDrillLOVRetrievalMode(DrillLOVRetrievalMode.ALL);
 retBOData.setRetrieveDrillInfo(boDrillInfo);

 Drill objDrill = Drill.Factory.newInstance();
 objDrill.setActiveDrill(true);
 Action[] actions = new Action[1];
 actions[0] = objDrill;
 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,actions,null, null);
 //Retrieve the drill information from the document
 DrillInfo boDocDrill = docInfo.getDrillInfo();
 DrillHierarchy[] boDrHiers = boDocDrill.getDrillHierarchiesArray();
 DrillHierarchy boDrHier = boDrHiers[0];
 DrillDimension[] boDrDims = boDrHier.getDrillDimensionsArray();
 

See Drill for an example of how to activate the drill in a document.
Note A DrillInfo object is only returned when a RetrieveDrillInfo is set in the RetrieveData object passed to ReportEngine.getDocumentInformation.

See Also:

DrillPath, DrillHierarchy, Action, DocumentInformation, Refresh, RetrieveData

Nested Class Summary

static class

DrillInfo.Factory A class with methods for creating instances of the DrillInfo type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

DrillBar	addNewDrillBar() Internal Use Only
DrillHierarchy	addNewDrillHierarchies() Internal Use Only.
DrillDetail	addNewFreeDrillDetails() Internal Use Only.
DrillDimension	addNewFreeDrillDimensions() Internal Use Only.
java.lang.String	getActiveBlockID() Returns the ID of the report block.
DrillBar	getDrillBar() Gets the DrillBar Object from the current drill operation.
DrillHierarchy[]	getDrillHierarchiesArray() Retrieve an array of DrillHierarchies associated to this document.
DrillHierarchy	getDrillHierarchiesArray(int i) Retrieve one DrillHierarchy associated to this document.
DrillDetail[]	getFreeDrillDetailsArray() Retrieves an array of free DrillDetails associated to this document.
DrillDetail	getFreeDrillDetailsArray(int i) Retrieves a free DrillDetail associated to this document.
DrillDimension[]	getFreeDrillDimensionsArray() Retrieves an array of free DrillDimensions associated to this document.
DrillDimension	getFreeDrillDimensionsArray(int i) Retrieves a free DrillDimension associated to this document.
boolean	getWillGoOutOfScope() Returns true if drilling will make the report go out of scope.
DrillHierarchy	insertNewDrillHierarchies(int i) Internal Use Only.
DrillDetail	insertNewFreeDrillDetails(int i) Internal Use Only.
DrillDimension	insertNewFreeDrillDimensions(int i) Internal Use Only.
boolean	isNilDrillBar() Checks if the DrillBar Object is nil.
boolean	isNilDrillHierarchiesArray(int i) Checks if the DrillHierarchies element is nil at the specified index position.
boolean	isNilFreeDrillDetailsArray(int i) Checks if the FreeDrillDetails element is nil at the specified index position.
boolean	isNilFreeDrillDimensionsArray(int i) Checks if the FreeDrillDimensions element is nil at the specified index position.
boolean	isSetDrillBar() Checks if the DrillBar element is set.
void	removeDrillHierarchies(int i) Internal Use Only.
void	removeFreeDrillDetails(int i) Internal Use Only.
void	removeFreeDrillDimensions(int i) Internal Use Only.
void	setActiveBlockID(java.lang.String activeBlockID) Internal Use Only.
void	setDrillBar(DrillBar drillBar) Internal Use Only
void	setDrillHierarchiesArray(DrillHierarchy[] drillHierarchiesArray) Internal Use Only.
void	setDrillHierarchiesArray(int i, DrillHierarchy drillHierarchies) Internal Use Only.
void	setFreeDrillDetailsArray(DrillDetail[] freeDrillDetailsArray) Internal Use Only.
void	setFreeDrillDetailsArray(int i, DrillDetail freeDrillDetails) Internal Use Only.
void	setFreeDrillDimensionsArray(DrillDimension[] freeDrillDimensionsArray) Internal Use Only.
void	setFreeDrillDimensionsArray(int i, DrillDimension freeDrillDimensions) Internal Use Only.
void	setNilDrillBar() Internal Use Only
void	setNilDrillHierarchiesArray(int i) Internal Use Only.
void	setNilFreeDrillDetailsArray(int i) Internal Use Only.
void	setNilFreeDrillDimensionsArray(int i) Sets the FreeDrillDimensions element to nil at the specified index position.
void	setWillGoOutOfScope(boolean willGoOutOfScope) Internal Use Only.
int	sizeOfDrillHierarchiesArray() Returns the number of DrillHierarchies element.
int	sizeOfFreeDrillDetailsArray() Returns the number of FreeDrillDetails element.
int	sizeOfFreeDrillDimensionsArray() Returns the number of FreeDrillDimensions element.
void	unsetDrillBar() Internal Use Only
org.apache.xmlbeans.XmlString	xgetActiveBlockID() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetWillGoOutOfScope() Internal Use Only.
void	xsetActiveBlockID(org.apache.xmlbeans.XmlString activeBlockID) Internal Use Only.
void	xsetWillGoOutOfScope(org.apache.xmlbeans.XmlBoolean willGoOutOfScope) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getDrillHierarchiesArray

DrillHierarchy[] getDrillHierarchiesArray()

Retrieve an array of DrillHierarchies associated to this document.

Returns:

an array of DrillHierarchies

See Also:

DrillHierarchy

getDrillHierarchiesArray

DrillHierarchy getDrillHierarchiesArray(int i)

Retrieve one DrillHierarchy associated to this document.

Parameters:

i - The index of the DrillHierarchy to be retrieved.

Returns:

a DrillHierarchy.

isNilDrillHierarchiesArray

boolean isNilDrillHierarchiesArray(int i)

Checks if the DrillHierarchies element is nil at the specified index position.

Parameters:

i - the index of the DrillHierarchy element

Returns:

true if the DrillHierarchy element is nil, otherwise false

sizeOfDrillHierarchiesArray

int sizeOfDrillHierarchiesArray()

Returns the number of DrillHierarchies element.

Returns:

the size of the DrillHierarchy array.

setDrillHierarchiesArray

void setDrillHierarchiesArray(DrillHierarchy[] drillHierarchiesArray)

Internal Use Only.

setDrillHierarchiesArray

void setDrillHierarchiesArray(int i,
                              DrillHierarchy drillHierarchies)

Internal Use Only.

setNilDrillHierarchiesArray

void setNilDrillHierarchiesArray(int i)

Internal Use Only.

insertNewDrillHierarchies

DrillHierarchy insertNewDrillHierarchies(int i)

Internal Use Only.

addNewDrillHierarchies

DrillHierarchy addNewDrillHierarchies()

Internal Use Only.

removeDrillHierarchies

void removeDrillHierarchies(int i)

Internal Use Only.

getFreeDrillDimensionsArray

DrillDimension[] getFreeDrillDimensionsArray()

Retrieves an array of free DrillDimensions associated to this document.
A free dimension is one that does not belong to a hierarchy.

Returns:

an array of DrillDimensions.

getFreeDrillDimensionsArray

DrillDimension getFreeDrillDimensionsArray(int i)

Retrieves a free DrillDimension associated to this document. A free dimension is one that does not belong to a hierarchy.

Parameters:

i - The index of the DrillHierarchy to be retrieved.

Returns:

a DrillDimension

See Also:

DrillDimension

isNilFreeDrillDimensionsArray

boolean isNilFreeDrillDimensionsArray(int i)

Checks if the FreeDrillDimensions element is nil at the specified index position.

Parameters:

i - the index of the FreeDrillDimension element

Returns:

true if the FreeDrillDimension element is nil, otherwise false

sizeOfFreeDrillDimensionsArray

int sizeOfFreeDrillDimensionsArray()

Returns the number of FreeDrillDimensions element.

Returns:

the size of the FreeDrillDimension array

setFreeDrillDimensionsArray

void setFreeDrillDimensionsArray(DrillDimension[] freeDrillDimensionsArray)

Internal Use Only.

setFreeDrillDimensionsArray

void setFreeDrillDimensionsArray(int i,
                                 DrillDimension freeDrillDimensions)

Internal Use Only.

setNilFreeDrillDimensionsArray

void setNilFreeDrillDimensionsArray(int i)

Sets the FreeDrillDimensions element to nil at the specified index position.

Parameters:

i - the index of the FreeDrillDimension element

insertNewFreeDrillDimensions

DrillDimension insertNewFreeDrillDimensions(int i)

Internal Use Only.

addNewFreeDrillDimensions

DrillDimension addNewFreeDrillDimensions()

Internal Use Only.

removeFreeDrillDimensions

void removeFreeDrillDimensions(int i)

Internal Use Only.

getFreeDrillDetailsArray

DrillDetail[] getFreeDrillDetailsArray()

Retrieves an array of free DrillDetails associated to this document.
A free detail is one that does not belong to a hierarchy.

Returns:

an array of DrillDetails.

getFreeDrillDetailsArray

DrillDetail getFreeDrillDetailsArray(int i)

Retrieves a free DrillDetail associated to this document. A free detail is one that does not belong to a hierarchy.

Parameters:

i - The index of the DrillDetail to be retrieved.

Returns:

a single free DrillDetail associated to this document.

isNilFreeDrillDetailsArray

boolean isNilFreeDrillDetailsArray(int i)

Checks if the FreeDrillDetails element is nil at the specified index position.

Parameters:

i - the index of the FreeDrillDetail element

Returns:

true if the FreeDrillDetail element is nil, otherwise false

sizeOfFreeDrillDetailsArray

int sizeOfFreeDrillDetailsArray()

Returns the number of FreeDrillDetails element.

Returns:

the size of the FreeDrillDetail element

setFreeDrillDetailsArray

void setFreeDrillDetailsArray(DrillDetail[] freeDrillDetailsArray)

Internal Use Only.

setFreeDrillDetailsArray

void setFreeDrillDetailsArray(int i,
                              DrillDetail freeDrillDetails)

Internal Use Only.

setNilFreeDrillDetailsArray

void setNilFreeDrillDetailsArray(int i)

Internal Use Only.

insertNewFreeDrillDetails

DrillDetail insertNewFreeDrillDetails(int i)

Internal Use Only.

addNewFreeDrillDetails

DrillDetail addNewFreeDrillDetails()

Internal Use Only.

removeFreeDrillDetails

void removeFreeDrillDetails(int i)

Internal Use Only.

getDrillBar

DrillBar getDrillBar()

Gets the DrillBar Object from the current drill operation.

Returns:

the DrillBar object

Since:

12.0

See Also:

DrillBarObject

isNilDrillBar

boolean isNilDrillBar()

Checks if the DrillBar Object is nil.

Returns:

true if the Drillbar element is nil, otherwise false

isSetDrillBar

boolean isSetDrillBar()

Checks if the DrillBar element is set.

Returns:

true if the Drillbar element is set, otherwise false

setDrillBar

void setDrillBar(DrillBar drillBar)

Internal Use Only

addNewDrillBar

DrillBar addNewDrillBar()

Internal Use Only

setNilDrillBar

void setNilDrillBar()

Internal Use Only

unsetDrillBar

void unsetDrillBar()

Internal Use Only

getActiveBlockID

java.lang.String getActiveBlockID()

Returns the ID of the report block.

Returns:

a string containing the ID of the report block.

xgetActiveBlockID

org.apache.xmlbeans.XmlString xgetActiveBlockID()

Internal Use Only.

setActiveBlockID

void setActiveBlockID(java.lang.String activeBlockID)

Internal Use Only.

xsetActiveBlockID

void xsetActiveBlockID(org.apache.xmlbeans.XmlString activeBlockID)

Internal Use Only.

getWillGoOutOfScope

boolean getWillGoOutOfScope()

Returns true if drilling will make the report go out of scope.

Returns:

true if drilling will make the report go out of scope.

xgetWillGoOutOfScope

org.apache.xmlbeans.XmlBoolean xgetWillGoOutOfScope()

Internal Use Only.

setWillGoOutOfScope

void setWillGoOutOfScope(boolean willGoOutOfScope)

Internal Use Only.

xsetWillGoOutOfScope

void xsetWillGoOutOfScope(org.apache.xmlbeans.XmlBoolean willGoOutOfScope)

Internal Use Only.