com.businessobjects.dsws.reportengine
Interface Drill

All Superinterfaces:

Action

public interface Drill
extends Action

The Drill interface is used to set and execute a drill operation in an open document.

Example: Entering into the drill mode.

 Action[] aobjActions = new Action[1];
 Drill objDrill = Drill.Factory.newInstance();
 objDrill.setActiveDrill(true);
 aobjActions[0] = objDrill;

 DrillOption objDrillOption = DrillOption.Factory.newInstance();
 objDrillOption.setCallbackFrame("view");
 objDrillOption.setCallbackScript("manageDrill.jsp");
 objDrillOption.setAmbiguousDrillCallbackScript("ambiguous.jsp");
 objDrillOption.setBlockHolder("block");
 objDrillOption.setFromHolder("from");
 objDrillOption.setDrillActionHolder("action");
 objDrillOption.setFilterHolder("filter");
 objDrillOption.setToHolder("to");
 objDrillOption.setHierarchyHolder("hierarchy");
 objDrillOption.setDocumentReferenceHolder("referenceHolder");

 CallbackOption[] aobjCallbackOptions = new CallbackOption[1];
 aobjCallbackOptions[0] = objDrillOption;
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOView.setCallbackOptionArray(aobjCallbackOptions);
 retBOData.setRetrieveView(retBOView);

 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,null,aobjActions,null,retBOData);
 CharacterView myBOView = (CharacterView)docInfo.getView();
 String docContents = myBOView.getContent();
 

See Also:

DrillPath, DrillHierarchy, DrillInfo, Action, DocumentInformation, RetrieveData

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

DrillPath	addNewDrillPath() Appends and returns a new empty DrillPath element.
ModifyDrillBar	addNewModifyDrillBar() Appends and returns a new empty ModifyDrillBar element.
boolean	getActiveDrill() Internal Use Only.
DrillPath	getDrillPath() Returns the DrillPath object.
ModifyDrillBar	getModifyDrillBar() Gets the ModifyDrillBar element.
boolean	getSnapshot() Internal Use Only.
boolean	isNilDrillPath() Checks if the DrillPath element is nil.
boolean	isNilModifyDrillBar() Checks if the ModifyDrillBar element is nil.
boolean	isSetDrillPath() Checks if the DrillPath element is set.
boolean	isSetModifyDrillBar() Checks if the ModifyDrillBar element is set.
void	setActiveDrill(boolean activeDrill) Set to true to activate the drill in this document when the Drill action is performed.
void	setDrillPath(DrillPath drillPath) Sets the path to be drilled to.
void	setModifyDrillBar(ModifyDrillBar modifyDrillBar) Sets the ModifyDrillBar element to the Drill object.
void	setNilDrillPath() Sets the DrillPath element to nil.
void	setNilModifyDrillBar() Sets the ModifyDrillBar element to nil.
void	setSnapshot(boolean snapshot) Set to true if this Drill action will create a duplicate report based on a snapshot of the current report's display.
void	unsetDrillPath() Unsets the DrillPath element.
void	unsetModifyDrillBar() Unsets the ModifyDrillBar element.
org.apache.xmlbeans.XmlBoolean	xgetActiveDrill() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetSnapshot() Internal Use Only.
void	xsetActiveDrill(org.apache.xmlbeans.XmlBoolean activeDrill) Internal Use Only.
void	xsetSnapshot(org.apache.xmlbeans.XmlBoolean snapshot) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getDrillPath

DrillPath getDrillPath()

Returns the DrillPath object.

Returns:

a DrillPath object.

isNilDrillPath

boolean isNilDrillPath()

Checks if the DrillPath element is nil.

Returns:

true if the DrillPath element is nil, otherwise false.

isSetDrillPath

boolean isSetDrillPath()

Checks if the DrillPath element is set.

Returns:

true if the DrillPath element is set, otherwise false.

setDrillPath

void setDrillPath(DrillPath drillPath)

Sets the path to be drilled to.

Parameters:

drillPath - the path to be drilled to.

See Also:

DrillPath

addNewDrillPath

DrillPath addNewDrillPath()

Appends and returns a new empty DrillPath element.

Returns:

a new empty DrillPath element.

setNilDrillPath

void setNilDrillPath()

Sets the DrillPath element to nil.

unsetDrillPath

void unsetDrillPath()

Unsets the DrillPath element.

getModifyDrillBar

ModifyDrillBar getModifyDrillBar()

Gets the ModifyDrillBar element.

Returns:

The ModifyDrillBar object.

isNilModifyDrillBar

boolean isNilModifyDrillBar()

Checks if the ModifyDrillBar element is nil.

Returns:

true if the ModifyDrillBar element is nil, otherwise false.

isSetModifyDrillBar

boolean isSetModifyDrillBar()

Checks if the ModifyDrillBar element is set.

Returns:

true if the ModifyDrillBar element is set, otherwise false.

setModifyDrillBar

void setModifyDrillBar(ModifyDrillBar modifyDrillBar)

Sets the ModifyDrillBar element to the Drill object.

Parameters:

modifyDrillBar - The ModifyDrillBar object.

addNewModifyDrillBar

ModifyDrillBar addNewModifyDrillBar()

Appends and returns a new empty ModifyDrillBar element.

Returns:

a new empty ModifyDrillBar element.

setNilModifyDrillBar

void setNilModifyDrillBar()

Sets the ModifyDrillBar element to nil.

unsetModifyDrillBar

void unsetModifyDrillBar()

Unsets the ModifyDrillBar element.

getActiveDrill

boolean getActiveDrill()

Internal Use Only.

xgetActiveDrill

org.apache.xmlbeans.XmlBoolean xgetActiveDrill()

Internal Use Only.

setActiveDrill

void setActiveDrill(boolean activeDrill)

Set to true to activate the drill in this document when the Drill action is performed.

Parameters:

activeDrill - Set to true to activate the drill.

See Also:

Action

xsetActiveDrill

void xsetActiveDrill(org.apache.xmlbeans.XmlBoolean activeDrill)

Internal Use Only.

getSnapshot

boolean getSnapshot()

Internal Use Only.

xgetSnapshot

org.apache.xmlbeans.XmlBoolean xgetSnapshot()

Internal Use Only.

setSnapshot

void setSnapshot(boolean snapshot)

Set to true if this Drill action will create a duplicate report based on a snapshot of the current report's display.

Parameters:

snapshot - true if this drill action is to create a snapshot.

See Also:

Action

xsetSnapshot

void xsetSnapshot(org.apache.xmlbeans.XmlBoolean snapshot)

Internal Use Only.