com.businessobjects.rebean.wi
Interface DrillOption


public interface DrillOption

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

The DrillOption interface provides access to the drill options.

See Also:
DrillPath

Method Summary
 java.lang.String getAmbiguousDrillCallBackScript()
          Returns the callback script URL for the ambiguous drill.
 java.lang.String getBlockHolder()
          Returns the "Block" variable name used in the HTTP query string.
 java.lang.String getCallBackFrame()
          Returns the frame name used during the HTML drill operations.
 java.lang.String getCallBackScript()
          Returns the callback script name.
 java.lang.String getDrillActionHolder()
          Returns the "DrillAction" variable name used in the HTTP query string.
 boolean getDrillOutOfScope()
          Determines the drill out of scope behavior.
 java.lang.String getFilterHolder()
          Returns the "Filter" variable name used in the HTTP query string.
 java.lang.String getFromHolder()
          Returns the "From" variable name used in the HTTP query string.
 boolean getGenerateDrillOutput()
          Returns the drill output mode, if false drill information (hyperlinks, ...) won't be generated.
 java.lang.String getHierarchyHolder()
          Returns the "Hierarchy" variable name used in the HTTP query string.
 java.lang.String getStorageTokenHolder()
          Returns the storage token variable name used in the HTTP query string.
 java.lang.String getToHolder()
          Returns the "To" variable name used in the HTTP query string.
 void setAmbiguousDrillCallBackScript(java.lang.String script)
          Assigns the callback script URL called during the HTML drill for ambiguous drill.
 void setBlockHolder(java.lang.String block)
          Sets the "Block" variable name used in the HTTP query string.
 void setCallBackFrame(java.lang.String callBackFrame)
          Assigns the target HTML frame name.
 void setCallBackScript(java.lang.String script)
          Assigns the callback script name called during the HTML drill.
 void setDrillActionHolder(java.lang.String drillAction)
          Sets the "DrillAction" variable name used in the HTTP query string.
 void setFilterHolder(java.lang.String filterHolder)
          Sets the "Filter" variable name used in the HTTP query string.
 void setFromHolder(java.lang.String fromHolder)
          Sets the "From" variable name used in the HTTP query string.
 void setGenerateDrillOutput(boolean generateDrill)
          Sets whether or not you want to generate drill information in the report output.
 void setHierarchyHolder(java.lang.String hierarchy)
          Sets the "Hierarchy" variable name used in the HTTP query string.
 void setStorageTokenHolder(java.lang.String tokenHolder)
          Sets the document storage token variable name used in the HTTP query string.
 void setToHolder(java.lang.String toHolder)
          Sets the "To" variable name used in the HTTP query string.
 

Method Detail

getCallBackScript

java.lang.String getCallBackScript()
Returns the callback script name.

Returns:
This script's name.

setCallBackScript

void setCallBackScript(java.lang.String script)
Assigns the callback script name called during the HTML drill. The default value is DefaultDrillHandler?

Parameters:
script - The script name called by the HTML page.

getAmbiguousDrillCallBackScript

java.lang.String getAmbiguousDrillCallBackScript()
Returns the callback script URL for the ambiguous drill.

Returns:
This script's URL.

setAmbiguousDrillCallBackScript

void setAmbiguousDrillCallBackScript(java.lang.String script)
Assigns the callback script URL called during the HTML drill for ambiguous drill.

Parameters:
script - The script URL called by the HTML page.

getCallBackFrame

java.lang.String getCallBackFrame()
Returns the frame name used during the HTML drill operations.

Returns:
this HTML frame's name

setCallBackFrame

void setCallBackFrame(java.lang.String callBackFrame)
Assigns the target HTML frame name. The default value is _self.

Parameters:
callBackFrame - this HTML frame's name.

getFromHolder

java.lang.String getFromHolder()
Returns the "From" variable name used in the HTTP query string.

Returns:
the variable name.

setFromHolder

void setFromHolder(java.lang.String fromHolder)
Sets the "From" variable name used in the HTTP query string. The default variable name is From.

Parameters:
fromHolder - the from variable name.

getToHolder

java.lang.String getToHolder()
Returns the "To" variable name used in the HTTP query string.

Returns:
the variable name.

setToHolder

void setToHolder(java.lang.String toHolder)
Sets the "To" variable name used in the HTTP query string. The default variable name is To.

Parameters:
toHolder - the from variable name.

getDrillActionHolder

java.lang.String getDrillActionHolder()
Returns the "DrillAction" variable name used in the HTTP query string.

Returns:
the variable name.

setDrillActionHolder

void setDrillActionHolder(java.lang.String drillAction)
Sets the "DrillAction" variable name used in the HTTP query string. The default variable name is DrillAction.

Parameters:
drillAction - The from variable name.

getBlockHolder

java.lang.String getBlockHolder()
Returns the "Block" variable name used in the HTTP query string.

Returns:
the variable name.

setBlockHolder

void setBlockHolder(java.lang.String block)
Sets the "Block" variable name used in the HTTP query string. The default variable name is Block.

Parameters:
block - The from variable name.

getHierarchyHolder

java.lang.String getHierarchyHolder()
Returns the "Hierarchy" variable name used in the HTTP query string.

Returns:
the variable name.

setHierarchyHolder

void setHierarchyHolder(java.lang.String hierarchy)
Sets the "Hierarchy" variable name used in the HTTP query string. The default variable name is Hierarchy.

Parameters:
hierarchy - The from variable name.

getFilterHolder

java.lang.String getFilterHolder()
Returns the "Filter" variable name used in the HTTP query string.

Returns:
the variable name.

setFilterHolder

void setFilterHolder(java.lang.String filterHolder)
Sets the "Filter" variable name used in the HTTP query string. The default variable name is Filter.

Parameters:
filterHolder - the filter variable name.

getStorageTokenHolder

java.lang.String getStorageTokenHolder()
Returns the storage token variable name used in the HTTP query string.

Returns:
the storage token variable name.

setStorageTokenHolder

void setStorageTokenHolder(java.lang.String tokenHolder)
Sets the document storage token variable name used in the HTTP query string. The storage token reveals a document's state; it includes information such as passwords and prompts. The default variable name is entry.

Parameters:
tokenHolder - The storage token variable name.

getDrillOutOfScope

boolean getDrillOutOfScope()
Determines the drill out of scope behavior. An analysis is considered as out of scope when it lacks one or more dimensions necessary for drilling up or down. There are dimensions that were not included in the original analysis.

Returns:
true if the drill out of scope is transparent (new query is made transparently) false otherwise.

setGenerateDrillOutput

void setGenerateDrillOutput(boolean generateDrill)
Sets whether or not you want to generate drill information in the report output.

By default this option is set to true.

Parameters:
generateDrill - if true drill information will be generated in report output.
Since:
12.5

getGenerateDrillOutput

boolean getGenerateDrillOutput()
Returns the drill output mode, if false drill information (hyperlinks, ...) won't be generated.

Returns:
true if drill information is written in the report output otherwise false.
Since:
12.5