Interface IDrillThroughAction


public interface IDrillThroughAction
Providers interface for the action process of drill through.

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.

  • Method Summary

    Modifier and Type
    Method
    Description
    Get the bookmark.
    Get the format of the target report if the action type is drillthrough.
    Get a set of name/value pairs for running the target report in a drillthrough link.
    Get the target report name if the action type is drillthrough which is predefined.
    Get a set of name/value pairs for searching the target report in a drillthrough link.
    Get the type of the target file.
    Get the target window.
    boolean
    Return the bookmark type set in the drillthrough action.
    void
    setBookmark(String bookmark)
    Set the bookmark type of this drillthrough action.
    void
    setBookmarkType(boolean isBookmark)
    Set the type of bookmark.
    void
    setFormat(String format)
    set the format of the output report.
    void
    setParameterBindings(Map parameterBindings)
    Set a set of name/value pairs for running the target report in a drillthrough link.
    void
    setReportName(String reportName)
    Set the target report name if the action type is drillthrough which is predefined.
    void
    setSearchCriteria(Map searchCriteria)
    Set a set of name/value pairs for searching the target report in a drillthrough link.
    void
    setTargetFileType(String targetFileType)
    Sets the type of target report file for a drill-through action.
    void
    Set the target window in string format.
  • Method Details

    • getReportName

      String getReportName()
      Get the target report name if the action type is drillthrough which is predefined.
      Returns:
      the report name.
    • setReportName

      void setReportName(String reportName)
      Set the target report name if the action type is drillthrough which is predefined.
      Parameters:
      reportName - the report name
    • getParameterBindings

      Map getParameterBindings()
      Get a set of name/value pairs for running the target report in a drillthrough link.
      Returns:
      a set of name/value pairs for running the target report in a drillthrough link.
    • getSearchCriteria

      Map getSearchCriteria()
      Get a set of name/value pairs for searching the target report in a drillthrough link.
      Returns:
      a set of name/value pairs for searching the target report in a drillthrough link.
    • getFormat

      String getFormat()
      Get the format of the target report if the action type is drillthrough. This format is used for building the URL when explorer between reports, running the target report and related process.
      Returns:
      the format of output report if action type is drillthrough.
    • isBookmark

      boolean isBookmark()
      Return the bookmark type set in the drillthrough action. The return result indicated the target element is a toc or not.
      Returns:
      true, the target element is a bookmark. false, the target element is indicated to be a toc.
    • setBookmark

      void setBookmark(String bookmark)
      Set the bookmark type of this drillthrough action.
      Parameters:
      bookmark - true, the target element is a bookmark. or false, the target element is indicated to be a toc.
    • getBookmark

      String getBookmark()
      Get the bookmark.
      Returns:
      the bookmark string if the bookmark type is Bookmark and action type is drillthrough. Return null if the bookmark type is TOC and action type is drillthrough.
    • getTargetWindow

      String getTargetWindow()
      Get the target window.
      Returns:
      the targetWindow string if action type is drillthrough.
    • setBookmarkType

      void setBookmarkType(boolean isBookmark)
      Set the type of bookmark. true, is a bookmark. false, indicated to be a toc.
      Type Parameters:
      code - isBookmark the bookmark type is toc or not.
    • setParameterBindings

      void setParameterBindings(Map parameterBindings)
      Set a set of name/value pairs for running the target report in a drillthrough link.
      Parameters:
      parameterBindings - a set of name/value pairs for running the report in a drillthrough link.
    • setSearchCriteria

      void setSearchCriteria(Map searchCriteria)
      Set a set of name/value pairs for searching the target report in a drillthrough link.
      Parameters:
      searchCriteria - a set of name/value pairs for searching the report in a drillthrough link.
    • setTargetWindow

      void setTargetWindow(String target)
      Set the target window in string format.
      Parameters:
      target - the target window.
    • setFormat

      void setFormat(String format)
      set the format of the output report.
      Parameters:
      format - the format of the output report.
    • setTargetFileType

      void setTargetFileType(String targetFileType)
      Sets the type of target report file for a drill-through action.
      Parameters:
      targetFileType - the type of the target file
    • getTargetFileType

      String getTargetFileType()
      Get the type of the target file.
      Returns:
      the type of the target report file.