org.eclipse.birt.report.engine.api.script.instance
Interface IDrillThroughInstance


public interface IDrillThroughInstance


Method Summary
 java.lang.String getBookmark()
           
 java.lang.String getFormat()
           
 java.util.Map getParameterBindings()
           
 java.lang.String getReportName()
           
 java.util.Map getSearchCriteria()
           
 java.lang.String getTargetFileType()
           
 java.lang.String getTargetWindow()
           
 java.lang.String getTOC()
           
 boolean isBookmark()
           
 void setBookmark(java.lang.String bookmark)
          Set the bookmark to the drillThrough .
 void setFormat(java.lang.String format)
          Set the format of output report.
 void setParameterBindings(java.util.Map parameterBindings)
          Set a set of name/value pairs for running the report in the drillthrough link.
 void setReportName(java.lang.String reportName)
          Set the report name.
 void setSearchCriteria(java.util.Map searchCriteria)
          Set a set of name/value pairs for searching the report in the drillthrough link.
 void setTargetFileType(java.lang.String targetFileType)
          Sets target report file type for a drill-through action.
 void setTargetWindow(java.lang.String target)
          Set the targetWindow string.
 void setTOC(java.lang.String toc)
          Set the TOC of this drillThrough.
 

Method Detail

getReportName

public java.lang.String getReportName()
Returns:
the report name.

setReportName

public void setReportName(java.lang.String reportName)
Set the report name.

Parameters:
reportName -

getParameterBindings

public java.util.Map getParameterBindings()
Returns:
a set of name/value pairs for running the report in the drillthrough link.

setParameterBindings

public void setParameterBindings(java.util.Map parameterBindings)
Set a set of name/value pairs for running the report in the drillthrough link.


getSearchCriteria

public java.util.Map getSearchCriteria()
Returns:
a set of name/value pairs for searching the report in the drillthrough link.

setSearchCriteria

public void setSearchCriteria(java.util.Map searchCriteria)
Set a set of name/value pairs for searching the report in the drillthrough link.


getFormat

public java.lang.String getFormat()
Returns:
the format of output report.

setFormat

public void setFormat(java.lang.String format)
Set the format of output report.


isBookmark

public boolean isBookmark()
Returns:
the bookmark type. True, the bookmark is a bookmark. False, the bookmark is a toc.

setBookmark

public void setBookmark(java.lang.String bookmark)
Set the bookmark to the drillThrough .

Parameters:
bookmark -

getBookmark

public java.lang.String getBookmark()
Returns:
the bookmark string if the bookmark type is Bookmark. NULL if the bookmark type is TOC.

setTOC

public void setTOC(java.lang.String toc)
Set the TOC of this drillThrough.

Parameters:
toc -

getTOC

public java.lang.String getTOC()
Returns:
the bookmark string if the bookmark type is TOC. NULL if the bookmark type is Bookmark.

getTargetWindow

public java.lang.String getTargetWindow()
Returns:
the targetWindow string.

setTargetWindow

public void setTargetWindow(java.lang.String target)
Set the targetWindow string.


setTargetFileType

public void setTargetFileType(java.lang.String targetFileType)
Sets target report file type for a drill-through action.


getTargetFileType

public java.lang.String getTargetFileType()
Returns:
the type of the target report file.


Copyright © 2005 Actuate Corp. All rights reserved.