|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DrillOption
Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.
TheDrillOption
interface provides access to the drill options.
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 |
---|
java.lang.String getCallBackScript()
void setCallBackScript(java.lang.String script)
DefaultDrillHandler?
script
- The script name called by the HTML page.java.lang.String getAmbiguousDrillCallBackScript()
void setAmbiguousDrillCallBackScript(java.lang.String script)
script
- The script URL called by the HTML page.java.lang.String getCallBackFrame()
void setCallBackFrame(java.lang.String callBackFrame)
_self
.
callBackFrame
- this HTML frame's name.java.lang.String getFromHolder()
void setFromHolder(java.lang.String fromHolder)
From
.
fromHolder
- the from variable name.java.lang.String getToHolder()
void setToHolder(java.lang.String toHolder)
To
.
toHolder
- the from variable name.java.lang.String getDrillActionHolder()
void setDrillActionHolder(java.lang.String drillAction)
DrillAction
.
drillAction
- The from variable name.java.lang.String getBlockHolder()
void setBlockHolder(java.lang.String block)
Block
.
block
- The from variable name.java.lang.String getHierarchyHolder()
void setHierarchyHolder(java.lang.String hierarchy)
Hierarchy
.
hierarchy
- The from variable name.java.lang.String getFilterHolder()
void setFilterHolder(java.lang.String filterHolder)
Filter
.
filterHolder
- the filter variable name.java.lang.String getStorageTokenHolder()
void setStorageTokenHolder(java.lang.String tokenHolder)
entry
.
tokenHolder
- The storage token variable name.boolean getDrillOutOfScope()
true
if the drill out of scope is transparent (new query is made transparently)
false
otherwise.void setGenerateDrillOutput(boolean generateDrill)
By default this option is set to true
.
generateDrill
- if true
drill information will be generated in report output.boolean getGenerateDrillOutput()
false
drill information (hyperlinks, ...) won't be generated.
true
if drill information is written in the report output otherwise false
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |