com.ibm.tivoli.maximo.report.birt.admin

Class ReportRunInfo

  • java.lang.Object
    • com.ibm.tivoli.maximo.report.birt.admin.ReportRunInfo
  • All Implemented Interfaces:
    java.io.Serializable


    public class ReportRunInfo
    extends java.lang.Object
    implements java.io.Serializable
    A Class used for representing the runtime information used for executing the report.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      ReportRunInfo() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getAppName()
      Returns the name of the application that uses this report.
      java.lang.String getReportFolderName()
      Returns the unique Report folder name (fully qualified path) where the report is exported out of the MAXIMO database.
      java.lang.String getReportName()
      Returns the report name.
      java.lang.String getReportOutputFolderName()
      Returns the unique Report output folder name (fully qualified path) used by the BIRT Report Engine to store the report output (intermediate format).
      ReportParameterInfo[] getReportParameterInfo() 
      java.lang.String getReportRelativePath()
      Returns the relative report path.
      java.lang.String getTempRunFolder()
      Returns the unique folder (fully qualified path) used for running the report.
      void setAppName(java.lang.String appName)
      Sets the name of the application that uses this report.
      void setReportFolderName(java.lang.String reportFolderName)
      Sets the unique Report folder name (fully qualified path) where the report is exported out of the MAXIMO database.
      void setReportName(java.lang.String reportName)
      Sets the report name.
      void setReportOutputFolderName(java.lang.String reportOutputFolderName)
      Sets unique Report output folder name (fully qualified path) used by the BIRT Report Engine to store the report output (intermediate format).
      void setReportParameterInfo(ReportParameterInfo[] paramInfo) 
      void setReportRelativePath(java.lang.String reportRelativePath)
      Sets the relative report path.
      void setTempRunFolder(java.lang.String tempFolder)
      Sets unique folder (fully qualified path) used for running the report.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ReportRunInfo

        public ReportRunInfo()
    • Method Detail

      • getReportFolderName

        public java.lang.String getReportFolderName()
        Returns the unique Report folder name (fully qualified path) where the report is exported out of the MAXIMO database. This folder contains the report XML file as well as all the dependent report library files and all resources used by the report as well as dependent libraries.
        Returns:
        unique Report folder name (fully qualified path)
      • setReportFolderName

        public void setReportFolderName(java.lang.String reportFolderName)
        Sets the unique Report folder name (fully qualified path) where the report is exported out of the MAXIMO database. This folder contains the report XML file as well as all the dependent report library files and all resources used by the report as well as dependent libraries.
        Parameters:
        reportFolderName -
      • getReportName

        public java.lang.String getReportName()
        Returns the report name.
        Returns:
      • setReportName

        public void setReportName(java.lang.String reportName)
        Sets the report name.
        Parameters:
        reportName -
      • getAppName

        public java.lang.String getAppName()
        Returns the name of the application that uses this report.
        Returns:
        application name.
      • setAppName

        public void setAppName(java.lang.String appName)
        Sets the name of the application that uses this report.
        Parameters:
        appName -
      • getReportOutputFolderName

        public java.lang.String getReportOutputFolderName()
        Returns the unique Report output folder name (fully qualified path) used by the BIRT Report Engine to store the report output (intermediate format).
        Returns:
      • setReportOutputFolderName

        public void setReportOutputFolderName(java.lang.String reportOutputFolderName)
        Sets unique Report output folder name (fully qualified path) used by the BIRT Report Engine to store the report output (intermediate format).
        Parameters:
        reportOutputFolderName -
      • getTempRunFolder

        public java.lang.String getTempRunFolder()
        Returns the unique folder (fully qualified path) used for running the report. This is like a root folder under which the report is exported and run.
        Returns:
      • setTempRunFolder

        public void setTempRunFolder(java.lang.String tempFolder)
        Sets unique folder (fully qualified path) used for running the report. This is like a root folder under which the report is exported and run.
        Parameters:
        tempFolder -
      • getReportRelativePath

        public java.lang.String getReportRelativePath()
        Returns the relative report path. Report Relative Path with respect to the reportruntime\reports folder. Used by the WebViewer code.
        Parameters:
        reportRelativePath -
      • setReportRelativePath

        public void setReportRelativePath(java.lang.String reportRelativePath)
        Sets the relative report path. Report Relative Path with respect to the reportruntime\reports folder. Used by the WebViewer code.
        Parameters:
        reportRelativePath -
      • setReportParameterInfo

        public void setReportParameterInfo(ReportParameterInfo[] paramInfo)