Package com.appliedolap.essbase

Interface EssDrillthrough

All Known Implementing Classes:
EssDrillthroughImpl
public interface EssDrillthrough

  • Method Details

    • getCube

      EssCube getCube()
      Returns the cube that owns this drill-through object.
      Returns:
      the parent cube for this drill-through definition

    • getName

      String getName()
      Gets the name of this drill-through report.
      Returns:
      the drill-through name

    • getType

      EssObject.Type getType()

    • getUrl

      String getUrl()
      Gets the URL of this drill-through report (URL-style only!). This API will likely change soon as support for different drill-through types is built out.
      Returns:
      the drill URL if there is one, null otherwise, such as on data source reports

    • getDrillthroughType

      EssDrillthrough.DrillthroughType getDrillthroughType()
      Gets the type of report, which will be either DATASOURCE or URL. This method causes a fetch to the drill-through report definition endpoint if it hasn't already been fetched.
      Returns:
      the type
      See Also:

    • setUrl

      void setUrl(String url)
      Sets the drill (again, likely to change soon)
      Parameters:
      url - the drill URL

    • getDrillableRegions

      List<String> getDrillableRegions()
      Get the drillable regions.
      Returns:
      the list of drillable regions

    • setDrillableRegions

      void setDrillableRegions(List<String> drillableRegions)
      Sets the drillable regions for this report
      Parameters:
      drillableRegions - the drillable regions

    • isUseTempTables

      boolean isUseTempTables()
      Gets the useTempTables parameter for this report which is only valid using Oracle DB.
      Returns:
      the use temp tables setting

    • setUseTempTables

      void setUseTempTables(boolean useTempTables)
      Sets the useTempTables parameter for this report which is only valid using Oracle DB.
      Parameters:
      useTempTables - the use temp tables setting

    • getDataSourceName

      String getDataSourceName()
      Gets the name of the data source for this report.
      Returns:
      the name of the data source.

    • setDataSourceName

      void setDataSourceName(String dataSourceName)
      Sets the name of the data source for this report.
      Parameters:
      dataSourceName - the name of the data source

    • save

      void save()
      Saves updates to this report

    • delete

      void delete()
      Deletes this drill-through report