com.businessobjects.dsws.reportengine
Interface DrillOption

All Superinterfaces:

CallbackOption

public interface DrillOption
extends CallbackOption

The DrillOption interface passes necessary information to the callback scripts.

Example:Passing the drill parameters to the CallbackScript.

 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;
 

See Also:

Action, CallbackOption, EmbeddedCallbackOption, ImageManagement, RetrieveView, RetrieveData, DocumentInformation

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getAmbiguousDrillCallbackScript() Internal Use Only.
java.lang.String	getBlockHolder() Internal Use Only.
java.lang.String	getDrillActionHolder() Internal Use Only.
java.lang.String	getFilterHolder() Internal Use Only.
java.lang.String	getFromHolder() Internal Use Only.
java.lang.String	getHierarchyHolder() Internal Use Only.
java.lang.String	getToHolder() Internal Use Only.
boolean	isSetAmbiguousDrillCallbackScript() Checks if the AmbiguousDrillCallbackScript attribute is set.
boolean	isSetBlockHolder() Checks if the BlockHolder attribute is set.
boolean	isSetDrillActionHolder() Checks if the DrillActionHolder attribute is set.
boolean	isSetFilterHolder() Checks if the FilterHolder attribute is set.
boolean	isSetFromHolder() Checks if the FromHolder attribute is set.
boolean	isSetHierarchyHolder() Checks if the HierarchyHolder attribute is set.
boolean	isSetToHolder() Checks if the ToHolder attribute is set.
void	setAmbiguousDrillCallbackScript(java.lang.String ambiguousDrillCallbackScript) Sets the name of the script to be called when a drill is ambiguous.
void	setBlockHolder(java.lang.String blockHolder) Sets the name of the parameter in the URL that contains the block to be drilled on.
void	setDrillActionHolder(java.lang.String drillActionHolder) Sets the name of the parameter in the URL that contains the Drill Action.
void	setFilterHolder(java.lang.String filterHolder) Sets the name of the parameter in the URL that contains the Drill filter.
void	setFromHolder(java.lang.String fromHolder) Sets the name of the parameter in the URL which contains the DrillDimension ID the user drilled from.
void	setHierarchyHolder(java.lang.String hierarchyHolder) Sets the name of the parameter in the URL that contains the ID of the drill hierarchy.
void	setToHolder(java.lang.String toHolder) Sets the name of the parameter in the URL which contains the DrillDimension ID the user will drill to.
void	unsetAmbiguousDrillCallbackScript() Unsets the AmbiguousDrillCallbackScript attribute
void	unsetBlockHolder() Unsets the BlockHolder attribute.
void	unsetDrillActionHolder() Unsets the DrillActionHolder attribute
void	unsetFilterHolder() Unsets the FilterHolder attribute.
void	unsetFromHolder() Unsets the FromHolder attribute.
void	unsetHierarchyHolder() Unsets the HierarchyHolder attribute.
void	unsetToHolder() Unsets the ToHolder attribute.
org.apache.xmlbeans.XmlString	xgetAmbiguousDrillCallbackScript() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetBlockHolder() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDrillActionHolder() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFilterHolder() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFromHolder() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetHierarchyHolder() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetToHolder() Internal Use Only.
void	xsetAmbiguousDrillCallbackScript(org.apache.xmlbeans.XmlString ambiguousDrillCallbackScript) Internal Use Only.
void	xsetBlockHolder(org.apache.xmlbeans.XmlString blockHolder) Internal Use Only.
void	xsetDrillActionHolder(org.apache.xmlbeans.XmlString drillActionHolder) Internal Use Only.
void	xsetFilterHolder(org.apache.xmlbeans.XmlString filterHolder) Internal Use Only.
void	xsetFromHolder(org.apache.xmlbeans.XmlString fromHolder) Internal Use Only.
void	xsetHierarchyHolder(org.apache.xmlbeans.XmlString hierarchyHolder) Internal Use Only.
void	xsetToHolder(org.apache.xmlbeans.XmlString toHolder) Internal Use Only.

Methods inherited from interface com.businessobjects.dsws.reportengine.CallbackOption

getCallbackFrame, getCallbackScript, getDocumentReferenceHolder, isSetCallbackFrame, isSetCallbackScript, isSetDocumentReferenceHolder, setCallbackFrame, setCallbackScript, setDocumentReferenceHolder, unsetCallbackFrame, unsetCallbackScript, unsetDocumentReferenceHolder, xgetCallbackFrame, xgetCallbackScript, xgetDocumentReferenceHolder, xsetCallbackFrame, xsetCallbackScript, xsetDocumentReferenceHolder

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getFromHolder

java.lang.String getFromHolder()

Internal Use Only.

xgetFromHolder

org.apache.xmlbeans.XmlString xgetFromHolder()

Internal Use Only.

isSetFromHolder

boolean isSetFromHolder()

Checks if the FromHolder attribute is set.

Returns:

true if the FromHolder attribute is set, otherwise false

setFromHolder

void setFromHolder(java.lang.String fromHolder)

Sets the name of the parameter in the URL which contains the DrillDimension ID the user drilled from. This parameter is passed to the callback in the URL string.
The DrillDimension ID the user has drilled from can be recovered in the callback as follows

Example: Set the drill from DrillDimension ID holder.

page1.jsp
DrillOption.setFromHolder("drillFrom");

drillCallbackScript.jsp
String drillFrom = request.getParameter( "drillFrom" );


Parameters:

fromHolder - a string containing the holder (parameter) name.

xsetFromHolder

void xsetFromHolder(org.apache.xmlbeans.XmlString fromHolder)

Internal Use Only.

unsetFromHolder

void unsetFromHolder()

Unsets the FromHolder attribute.

getToHolder

java.lang.String getToHolder()

Internal Use Only.

xgetToHolder

org.apache.xmlbeans.XmlString xgetToHolder()

Internal Use Only.

isSetToHolder

boolean isSetToHolder()

Checks if the ToHolder attribute is set.

Returns:

true if the ToHolder attribute is set, otherwise false

setToHolder

void setToHolder(java.lang.String toHolder)

Sets the name of the parameter in the URL which contains the DrillDimension ID the user will drill to. This parameter is passed to the callback in the URL string.
The DrillDimension ID the user will drill to can be recovered in the callback as follows

Example: Set the drill to DrillDimension ID holder.

page1.jsp
DrillOption.setToHolder("drillTo");

drillCallbackScript.jsp
String drillTo = request.getParameter( "drillTo" );


Parameters:

toHolder - A string containing the holder (parameter) name.

xsetToHolder

void xsetToHolder(org.apache.xmlbeans.XmlString toHolder)

Internal Use Only.

unsetToHolder

void unsetToHolder()

Unsets the ToHolder attribute.

getDrillActionHolder

java.lang.String getDrillActionHolder()

Internal Use Only.

xgetDrillActionHolder

org.apache.xmlbeans.XmlString xgetDrillActionHolder()

Internal Use Only.

isSetDrillActionHolder

boolean isSetDrillActionHolder()

Checks if the DrillActionHolder attribute is set.

Returns:

true if the DrillActionHolder attribute is set, otherwise false

setDrillActionHolder

void setDrillActionHolder(java.lang.String drillActionHolder)

Sets the name of the parameter in the URL that contains the Drill Action. This parameter is passed to the callback in the URL string.
The drill Action can be recovered in the callback as follows

Example: Retrieve a drill Action.

page1.jsp
DrillOption.setDrillActionHolder("drillAction");
drillCallbackScript.jsp
String drillAction = request.getParameter( "drillAction" );


Parameters:

drillActionHolder - A string containing the holder (parameter) name.

See Also:

Action

xsetDrillActionHolder

void xsetDrillActionHolder(org.apache.xmlbeans.XmlString drillActionHolder)

Internal Use Only.

unsetDrillActionHolder

void unsetDrillActionHolder()

Unsets the DrillActionHolder attribute

getFilterHolder

java.lang.String getFilterHolder()

Internal Use Only.

xgetFilterHolder

org.apache.xmlbeans.XmlString xgetFilterHolder()

Internal Use Only.

isSetFilterHolder

boolean isSetFilterHolder()

Checks if the FilterHolder attribute is set.

Returns:

true if the FilterHolder attribute is set, otherwise false

setFilterHolder

void setFilterHolder(java.lang.String filterHolder)

Sets the name of the parameter in the URL that contains the Drill filter. This parameter is passed to the callback in the URL string.
The drill filter can be recovered in the callback as follows

Example: Retrieve a drill filter.

page1.jsp
DrillOption.setFilterHolder("drillFilter");
drillCallbackScript.jsp
String drillFilter = request.getParameter( "drillFilter" );


Parameters:

filterHolder - A string containing the holder (parameter) name.

xsetFilterHolder

void xsetFilterHolder(org.apache.xmlbeans.XmlString filterHolder)

Internal Use Only.

unsetFilterHolder

void unsetFilterHolder()

Unsets the FilterHolder attribute.

getBlockHolder

java.lang.String getBlockHolder()

Internal Use Only.

xgetBlockHolder

org.apache.xmlbeans.XmlString xgetBlockHolder()

Internal Use Only.

isSetBlockHolder

boolean isSetBlockHolder()

Checks if the BlockHolder attribute is set.

Returns:

true if the BlockHolder attribute is set, otherwise false

setBlockHolder

void setBlockHolder(java.lang.String blockHolder)

Sets the name of the parameter in the URL that contains the block to be drilled on. This parameter is passed to the callback in the URL string.
The drill block can be recovered in the callback as follows

Example: Retrieve a drill block.

page1.jsp
DrillOption.setBlockHolder("drillBlock");
drillCallbackScript.jsp
String drillBlock = request.getParameter( "drillBlock" );


Parameters:

blockHolder - A string containing the holder (parameter) name.

xsetBlockHolder

void xsetBlockHolder(org.apache.xmlbeans.XmlString blockHolder)

Internal Use Only.

unsetBlockHolder

void unsetBlockHolder()

Unsets the BlockHolder attribute.

getHierarchyHolder

java.lang.String getHierarchyHolder()

Internal Use Only.

xgetHierarchyHolder

org.apache.xmlbeans.XmlString xgetHierarchyHolder()

Internal Use Only.

isSetHierarchyHolder

boolean isSetHierarchyHolder()

Checks if the HierarchyHolder attribute is set.

Returns:

true if the HierarchyHolder attribute is set, otherwise false

setHierarchyHolder

void setHierarchyHolder(java.lang.String hierarchyHolder)

Sets the name of the parameter in the URL that contains the ID of the drill hierarchy. This parameter is passed to the callback in the URL string.
The drill hierarchy ID can be recovered in the callback as follows

Example: Retrieve the drill hierarchy ID.

page1.jsp
DrillOption.setHierarchyHolder("drillHier");
drillCallbackScript.jsp
String drillHier = request.getParameter( "drillHier" );


Parameters:

hierarchyHolder - A string containing the holder (parameter) name.

xsetHierarchyHolder

void xsetHierarchyHolder(org.apache.xmlbeans.XmlString hierarchyHolder)

Internal Use Only.

unsetHierarchyHolder

void unsetHierarchyHolder()

Unsets the HierarchyHolder attribute.

getAmbiguousDrillCallbackScript

java.lang.String getAmbiguousDrillCallbackScript()

Internal Use Only.

xgetAmbiguousDrillCallbackScript

org.apache.xmlbeans.XmlString xgetAmbiguousDrillCallbackScript()

Internal Use Only.

isSetAmbiguousDrillCallbackScript

boolean isSetAmbiguousDrillCallbackScript()

Checks if the AmbiguousDrillCallbackScript attribute is set.

Returns:

true if the AmbiguousDrillCallbackScript attribute is set, otherwise false

setAmbiguousDrillCallbackScript

void setAmbiguousDrillCallbackScript(java.lang.String ambiguousDrillCallbackScript)

Sets the name of the script to be called when a drill is ambiguous.
A drill is ambiguous when the drillto dimension belongs to more than one drill hierarchy.
Note: The script name can be:

• Simple, for example:
  "ambiguousDrill.jsp".
• Complex and contain variables to be used by the callback script, for example:
  http://www.myserver.com/wijsp/ambiguousDrill.jsp?reportname=test

Parameters:

ambiguousDrillCallbackScript - String containing the name of the drill script.

xsetAmbiguousDrillCallbackScript

void xsetAmbiguousDrillCallbackScript(org.apache.xmlbeans.XmlString ambiguousDrillCallbackScript)

Internal Use Only.

unsetAmbiguousDrillCallbackScript

void unsetAmbiguousDrillCallbackScript()

Unsets the AmbiguousDrillCallbackScript attribute