public interface IDrillThroughAction
Drill through is a term of actions that explorer elements like bookmark
between two reports. Generally, via a drill through, we will get a movement
from some element in source report to element in target report. The class
IDrillThroughAction
indicates this action.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBookmark()
Get the bookmark.
|
java.lang.String |
getFormat()
Get the format of the target report if the action type is drillthrough.
|
java.util.Map |
getParameterBindings()
Get a set of name/value pairs for running the target report in a
drillthrough link.
|
java.lang.String |
getReportName()
Get the target report name if the action type is drillthrough which is predefined.
|
java.util.Map |
getSearchCriteria()
Get a set of name/value pairs for searching the target report in a
drillthrough link.
|
java.lang.String |
getTargetFileType()
Get the type of the target file.
|
java.lang.String |
getTargetWindow()
Get the target window.
|
boolean |
isBookmark()
Return the bookmark type set in the drillthrough action.
|
void |
setBookmark(java.lang.String bookmark)
Set the bookmark type of this drillthrough action.
|
void |
setBookmarkType(boolean isBookmark)
Set the type of bookmark.
|
void |
setFormat(java.lang.String format)
set the format of the output report.
|
void |
setParameterBindings(java.util.Map parameterBindings)
Set a set of name/value pairs for running the target report in a drillthrough
link.
|
void |
setReportName(java.lang.String reportName)
Set the target report name if the action type is drillthrough which is predefined.
|
void |
setSearchCriteria(java.util.Map searchCriteria)
Set a set of name/value pairs for searching the target report in a drillthrough
link.
|
void |
setTargetFileType(java.lang.String targetFileType)
Sets the type of target report file for a drill-through action.
|
void |
setTargetWindow(java.lang.String target)
Set the target window in string format.
|
java.lang.String getReportName()
void setReportName(java.lang.String reportName)
reportName
- the report namejava.util.Map getParameterBindings()
java.util.Map getSearchCriteria()
java.lang.String getFormat()
boolean isBookmark()
true
, the target element is a bookmark.
false
, the target element is indicated to be a
toc.void setBookmark(java.lang.String bookmark)
bookmark
- true
, the target element is a bookmark. or
false
, the target element is indicated to be a
toc.java.lang.String getBookmark()
null
if the bookmark type is TOC and action
type is drillthrough.java.lang.String getTargetWindow()
void setBookmarkType(boolean isBookmark)
true
, is a bookmark.
false
, indicated to be a toc.isBookmark
- the bookmark type is toc or not.void setParameterBindings(java.util.Map parameterBindings)
parameterBindings
- a set of name/value pairs for running the report in a
drillthrough link.void setSearchCriteria(java.util.Map searchCriteria)
searchCriteria
- a set of name/value pairs for searching the report in a
drillthrough link.void setTargetWindow(java.lang.String target)
target
- the target window.void setFormat(java.lang.String format)
format
- the format of the output report.void setTargetFileType(java.lang.String targetFileType)
targetFileType
- the type of the target filejava.lang.String getTargetFileType()
Copyright © 2014 OpenText Corp. All rights reserved.