Package step.repository.alm.v16.otaclient

Interface IReportManager

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com4j.Com4jObject createReportUserTemplate​(java.lang.String fileName, IList pFields, java.lang.String tmplType, int owningReportID, java.lang.String localFilePath)
      Creates a custom template
      java.lang.String downloadReport​(java.lang.String reportFileName)
      Downloads a report file
      java.lang.String downloadReportProjectTemplateFile​(int tmpltID)
      Downloads the project template file and returns the download path.
      java.lang.String downloadReportUserTemplateFile​(int tmpltID)
      Downloads the a custom template file and returns the download path.
      java.lang.String downloadTemplateCreator()
      Downloads the Template Creator file and returns the download path.
      int startGenerateReport​(int analysisItemId)
      Invokes a task that generates a full report data file on the server.
      int startGenerateReportPreview​(int analysisItemId)
      Invokes a task that generates a report preview data file on the server.
      int startGenerateVirtualReport​(java.lang.String reportConfigXml)
      Invokes a task that generates a full report data file on the server by sending a full configuration XML to the server.
      int startGenerateVirtualReportPreview​(java.lang.String reportConfigXml)
      Invokes a task that generates a report preview data file on the server by sending a full configuration XML to the server.
      void uploadReportProjectTemplateFile​(int tmpltID, java.lang.String localFilePath)
      Uploads a template file for the specified project template.

      • Methods inherited from interface com4j.Com4jObject

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

    • Method Detail

      • downloadReport

        java.lang.String downloadReport​(java.lang.String reportFileName)

        Downloads a report file

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

      • startGenerateReport

        int startGenerateReport​(int analysisItemId)

        Invokes a task that generates a full report data file on the server.

        Parameters:
        analysisItemId - Mandatory int parameter.
        Returns:
        Returns a value of type int

      • startGenerateReportPreview

        int startGenerateReportPreview​(int analysisItemId)

        Invokes a task that generates a report preview data file on the server.

        Parameters:
        analysisItemId - Mandatory int parameter.
        Returns:
        Returns a value of type int

      • startGenerateVirtualReport

        int startGenerateVirtualReport​(java.lang.String reportConfigXml)

        Invokes a task that generates a full report data file on the server by sending a full configuration XML to the server.

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

      • startGenerateVirtualReportPreview

        int startGenerateVirtualReportPreview​(java.lang.String reportConfigXml)

        Invokes a task that generates a report preview data file on the server by sending a full configuration XML to the server.

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

      • downloadReportProjectTemplateFile

        java.lang.String downloadReportProjectTemplateFile​(int tmpltID)

        Downloads the project template file and returns the download path.

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

      • downloadReportUserTemplateFile

        java.lang.String downloadReportUserTemplateFile​(int tmpltID)

        Downloads the a custom template file and returns the download path.

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

      • uploadReportProjectTemplateFile

        void uploadReportProjectTemplateFile​(int tmpltID,
                                     java.lang.String localFilePath)

        Uploads a template file for the specified project template.

        Parameters:
        tmpltID - Mandatory int parameter.
        localFilePath - Mandatory java.lang.String parameter.

      • createReportUserTemplate

        com4j.Com4jObject createReportUserTemplate​(java.lang.String fileName,
                                           IList pFields,
                                           java.lang.String tmplType,
                                           int owningReportID,
                                           java.lang.String localFilePath)

        Creates a custom template

        Parameters:
        fileName - Mandatory java.lang.String parameter.
        pFields - Mandatory step.repository.alm.v16.otaclient.IList parameter.
        tmplType - Mandatory java.lang.String parameter.
        owningReportID - Mandatory int parameter.
        localFilePath - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type com4j.Com4jObject

      • downloadTemplateCreator

        java.lang.String downloadTemplateCreator()

        Downloads the Template Creator file and returns the download path.

        Returns:
        Returns a value of type java.lang.String