org.eclipse.birt.report.engine.content
Interface IDrillThroughAction


public interface IDrillThroughAction


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()
           
 boolean isBookmark()
           
 void setBookmark(java.lang.String bookmark)
          Set the bookmark of this drillThrough if action type is drillthrough.
 void setBookmarkType(boolean isBookmark)
           
 void setFormat(java.lang.String format)
           
 void setParameterBindings(java.util.Map parameterBindings)
           
 void setReportName(java.lang.String reportName)
          If action type is drillthrough, set the report name.
 void setSearchCriteria(java.util.Map searchCriteria)
           
 void setTargetFileType(java.lang.String targetFileType)
          Sets target report file type for a drill-through action.
 void setTargetWindow(java.lang.String target)
           
 

Method Detail

getReportName

public java.lang.String getReportName()
Returns:
the report name if action type is drillthrough.

setReportName

public void setReportName(java.lang.String reportName)
If action type is drillthrough, set the report name.

Parameters:
reportName -

getParameterBindings

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

getSearchCriteria

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

getFormat

public java.lang.String getFormat()
Returns:
the format of output report if action type is drillthrough.

isBookmark

public boolean isBookmark()
Returns:
the bookmark type set in the drillThrough if action type is drillthrough. True, the bookmark is a bookmark. False, the bookmark is indicated to be a toc.

setBookmark

public void setBookmark(java.lang.String bookmark)
Set the bookmark of this drillThrough if action type is drillthrough.

Parameters:
bookmark -

getBookmark

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

getTargetWindow

public java.lang.String getTargetWindow()
Returns:
the targetWindow string if action type is drillthrough.

setBookmarkType

public void setBookmarkType(boolean isBookmark)

setParameterBindings

public void setParameterBindings(java.util.Map parameterBindings)

setSearchCriteria

public void setSearchCriteria(java.util.Map searchCriteria)

setTargetWindow

public void setTargetWindow(java.lang.String target)

setFormat

public void setFormat(java.lang.String format)

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.