Package step.repository.alm.v16.otaclient

Interface IBusinessViewsExcelReportManager

  • All Superinterfaces:
    com4j.Com4jObject
    All Known Subinterfaces:
    IBusinessViewsExcelReportManager2
    public interface IBusinessViewsExcelReportManager
extends com4j.Com4jObject
    For HP use. IBusinessViewsExcelReportManager Interface.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int autoPreviewMaxRows()
      Returns maximal number of rows allowed on auto preview request.
      java.lang.String downloadExcelReportResultFile​(java.lang.String fileNameToDownload)
      Downloads a excel report result file
      java.lang.String executeConfiguration​(java.lang.String configurationXML, java.lang.String worksheetID, int maxRowsCountToFetch, com4j.Holder<java.lang.String> resultAdditionalData)
      Generates a report data file according to the provided configuration xml.
      java.lang.String executeConfigurationOnRemoteProject​(java.lang.String configurationXML, java.lang.String worksheetID, int maxRowsCountToFetch, java.lang.String projectId, com4j.Holder<java.lang.String> resultAdditionalData)
      Generates a report data file according to the provided configuration xml on remote project.
      java.lang.String executeDql​(java.lang.String dql, int maxRowsCountToFetch, com4j.Holder<java.lang.String> resultAdditionalData)
      Generates a report data file according to the provided Dql.
      java.lang.String executeDqlOnRemoteProject​(java.lang.String dql, int maxRowsCountToFetch, java.lang.String projectId, com4j.Holder<java.lang.String> resultAdditionalData)
      Generates a report data file according to the provided Dql on remote project.
      int startConfigurationExecution​(java.lang.String configurationXML, java.lang.String worksheetID, int maxRowsCountToFetch, com4j.Holder<java.lang.String> resultAdditionalData)
      Starts excel report execution on the server according to the provided configuration XML.
      int startConfigurationExecutionOnRemoteProject​(java.lang.String configurationXML, java.lang.String worksheetID, int maxRowsCountToFetch, java.lang.String projectId, com4j.Holder<java.lang.String> resultAdditionalData)
      Starts excel report execution on the server according to the provided configuration XML on remote project.
      int startDqlExecution​(java.lang.String dql, int maxRowsCountToFetch, com4j.Holder<java.lang.String> resultAdditionalData)
      Starts excel report dql execution on the server according to the provided Dql string.
      int startDqlExecutionOnRemoteProject​(java.lang.String dql, int maxRowsCountToFetch, java.lang.String projectId, com4j.Holder<java.lang.String> resultAdditionalData)
      Starts excel report dql execution on the server according to the provided Dql string on remote project.
      boolean translateConfigurationToDql​(java.lang.String configurationXML, java.lang.String worksheetID, com4j.Holder<java.lang.String> resultAdditionalData, com4j.Holder<java.lang.String> resultDql)
      Translates configuration xml to dql.
      java.lang.String validateDql​(java.lang.String dql)
      Validates Dql according to current project customization.
      java.lang.String validateDqlOnRemoteProject​(java.lang.String dql, java.lang.String projectId)
      Validates Dql according to remote project customization.

      • Methods inherited from interface com4j.Com4jObject

        advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

    • Method Detail

      • executeDql

        java.lang.String executeDql​(java.lang.String dql,
                            int maxRowsCountToFetch,
                            com4j.Holder<java.lang.String> resultAdditionalData)

        Generates a report data file according to the provided Dql.

        Parameters:
        dql - Mandatory java.lang.String parameter.
        maxRowsCountToFetch - Mandatory int parameter.
        resultAdditionalData - Mandatory Holder parameter.
        Returns:
        Returns a value of type java.lang.String

      • startDqlExecution

        int startDqlExecution​(java.lang.String dql,
                      int maxRowsCountToFetch,
                      com4j.Holder<java.lang.String> resultAdditionalData)

        Starts excel report dql execution on the server according to the provided Dql string.

        Parameters:
        dql - Mandatory java.lang.String parameter.
        maxRowsCountToFetch - Mandatory int parameter.
        resultAdditionalData - Mandatory Holder parameter.
        Returns:
        Returns a value of type int

      • downloadExcelReportResultFile

        java.lang.String downloadExcelReportResultFile​(java.lang.String fileNameToDownload)

        Downloads a excel report result file

        Parameters:
        fileNameToDownload - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type java.lang.String

      • executeConfiguration

        java.lang.String executeConfiguration​(java.lang.String configurationXML,
                                      java.lang.String worksheetID,
                                      int maxRowsCountToFetch,
                                      com4j.Holder<java.lang.String> resultAdditionalData)

        Generates a report data file according to the provided configuration xml.

        Parameters:
        configurationXML - Mandatory java.lang.String parameter.
        worksheetID - Mandatory java.lang.String parameter.
        maxRowsCountToFetch - Mandatory int parameter.
        resultAdditionalData - Mandatory Holder parameter.
        Returns:
        Returns a value of type java.lang.String

      • startConfigurationExecution

        int startConfigurationExecution​(java.lang.String configurationXML,
                                java.lang.String worksheetID,
                                int maxRowsCountToFetch,
                                com4j.Holder<java.lang.String> resultAdditionalData)

        Starts excel report execution on the server according to the provided configuration XML.

        Parameters:
        configurationXML - Mandatory java.lang.String parameter.
        worksheetID - Mandatory java.lang.String parameter.
        maxRowsCountToFetch - Mandatory int parameter.
        resultAdditionalData - Mandatory Holder parameter.
        Returns:
        Returns a value of type int

      • translateConfigurationToDql

        boolean translateConfigurationToDql​(java.lang.String configurationXML,
                                    java.lang.String worksheetID,
                                    com4j.Holder<java.lang.String> resultAdditionalData,
                                    com4j.Holder<java.lang.String> resultDql)

        Translates configuration xml to dql.

        Parameters:
        configurationXML - Mandatory java.lang.String parameter.
        worksheetID - Mandatory java.lang.String parameter.
        resultAdditionalData - Mandatory Holder parameter.
        resultDql - Mandatory Holder parameter.
        Returns:
        Returns a value of type boolean

      • startDqlExecutionOnRemoteProject

        int startDqlExecutionOnRemoteProject​(java.lang.String dql,
                                     int maxRowsCountToFetch,
                                     java.lang.String projectId,
                                     com4j.Holder<java.lang.String> resultAdditionalData)

        Starts excel report dql execution on the server according to the provided Dql string on remote project.

        Parameters:
        dql - Mandatory java.lang.String parameter.
        maxRowsCountToFetch - Mandatory int parameter.
        projectId - Mandatory java.lang.String parameter.
        resultAdditionalData - Mandatory Holder parameter.
        Returns:
        Returns a value of type int

      • startConfigurationExecutionOnRemoteProject

        int startConfigurationExecutionOnRemoteProject​(java.lang.String configurationXML,
                                               java.lang.String worksheetID,
                                               int maxRowsCountToFetch,
                                               java.lang.String projectId,
                                               com4j.Holder<java.lang.String> resultAdditionalData)

        Starts excel report execution on the server according to the provided configuration XML on remote project.

        Parameters:
        configurationXML - Mandatory java.lang.String parameter.
        worksheetID - Mandatory java.lang.String parameter.
        maxRowsCountToFetch - Mandatory int parameter.
        projectId - Mandatory java.lang.String parameter.
        resultAdditionalData - Mandatory Holder parameter.
        Returns:
        Returns a value of type int

      • executeDqlOnRemoteProject

        java.lang.String executeDqlOnRemoteProject​(java.lang.String dql,
                                           int maxRowsCountToFetch,
                                           java.lang.String projectId,
                                           com4j.Holder<java.lang.String> resultAdditionalData)

        Generates a report data file according to the provided Dql on remote project.

        Parameters:
        dql - Mandatory java.lang.String parameter.
        maxRowsCountToFetch - Mandatory int parameter.
        projectId - Mandatory java.lang.String parameter.
        resultAdditionalData - Mandatory Holder parameter.
        Returns:
        Returns a value of type java.lang.String

      • executeConfigurationOnRemoteProject

        java.lang.String executeConfigurationOnRemoteProject​(java.lang.String configurationXML,
                                                     java.lang.String worksheetID,
                                                     int maxRowsCountToFetch,
                                                     java.lang.String projectId,
                                                     com4j.Holder<java.lang.String> resultAdditionalData)

        Generates a report data file according to the provided configuration xml on remote project.

        Parameters:
        configurationXML - Mandatory java.lang.String parameter.
        worksheetID - Mandatory java.lang.String parameter.
        maxRowsCountToFetch - Mandatory int parameter.
        projectId - Mandatory java.lang.String parameter.
        resultAdditionalData - Mandatory Holder parameter.
        Returns:
        Returns a value of type java.lang.String

      • validateDql

        java.lang.String validateDql​(java.lang.String dql)

        Validates Dql according to current project customization.

        Parameters:
        dql - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type java.lang.String

      • validateDqlOnRemoteProject

        java.lang.String validateDqlOnRemoteProject​(java.lang.String dql,
                                            java.lang.String projectId)

        Validates Dql according to remote project customization.

        Parameters:
        dql - Mandatory java.lang.String parameter.
        projectId - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type java.lang.String

      • autoPreviewMaxRows

        int autoPreviewMaxRows()

        Returns maximal number of rows allowed on auto preview request.

        Getter method for the COM property "AutoPreviewMaxRows"

        Returns:
        Returns a value of type int