Interface IReportManager

All Superinterfaces:
IDisposable, IEntity
public interface IReportManager extends IEntity
Manages the reports.

  • Method Details

    • deleteSavedReport

      void deleteSavedReport(String savedReportName) throws Exception, altitude.integrationServer.exceptions.ISException
      Deletes a saved report.
      Parameters:
      savedReportName - Name of the saved report.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • generateReport

      int generateReport(ReportGenerateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Generates a report.
      Parameters:
      request - Contains the fields for the report.
      Returns:
      Identifier of the created saved report.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getInstance

      IInstance getInstance() throws Exception, altitude.integrationServer.exceptions.ISException
      Returns the instance.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getReportTemplateById

      ReportTemplate getReportTemplateById(int reportTemplateId) throws Exception, altitude.integrationServer.exceptions.ISException
      Returns a ReportTemplate object with data about the report template.
      Parameters:
      reportTemplateId - Identifier of the report template.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getReportTemplateByName

      ReportTemplate getReportTemplateByName(String reportTemplateName) throws Exception, altitude.integrationServer.exceptions.ISException
      Returns a ReportTemplate object with data about the report template.
      Parameters:
      reportTemplateName - Name of the report template.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getReportTemplateCursor

      IReportTemplateCursor getReportTemplateCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a report template cursor open in the instance.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The IReportTemplateCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getReportTemplateCursors

      IReportTemplateCursor[] getReportTemplateCursors() throws Exception, altitude.integrationServer.exceptions.ISException
      Returns the report template cursors open in the instance.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getReportTemplateFilterColumnsById

      TableSchemaColumn[] getReportTemplateFilterColumnsById(int reportTemplateId) throws Exception, altitude.integrationServer.exceptions.ISException
      Returns an array of TableSchemaColumn objects with the report template filter columns.
      Parameters:
      reportTemplateId - Identifier of the report template.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getReportTemplateFilterColumnsByName

      TableSchemaColumn[] getReportTemplateFilterColumnsByName(String reportTemplateName) throws Exception, altitude.integrationServer.exceptions.ISException
      Returns an array of TableSchemaColumn objects with the report template filter columns.
      Parameters:
      reportTemplateName - Name of the report template.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getReportTemplateTableSchema

      TableSchema getReportTemplateTableSchema() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the table schema of the report template.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getSavedReportById

      SavedReport getSavedReportById(int savedReportId) throws Exception, altitude.integrationServer.exceptions.ISException
      Returns a SavedReport object with data about the saved report.
      Parameters:
      savedReportId - Identifier of the saved report.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getSavedReportByName

      SavedReport getSavedReportByName(String savedReportName) throws Exception, altitude.integrationServer.exceptions.ISException
      Returns a SavedReport object with data about the saved report.
      Parameters:
      savedReportName - Name of the saved report.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getSavedReportContentById

      byte[] getSavedReportContentById(int savedReportId, SavedReportFormat format) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the contents of the saved report in the specified format.
      Parameters:
      savedReportId - Identifier of the saved report.
      format - Format for the content.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getSavedReportContentByName

      byte[] getSavedReportContentByName(String savedReportName, SavedReportFormat format) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the contents of the saved report in the specified format.
      Parameters:
      savedReportName - Name of the saved report.
      format - Format for the content.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getSavedReportCursor

      ISavedReportCursor getSavedReportCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a saved report cursor open in the instance.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The ISavedReportCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getSavedReportCursors

      ISavedReportCursor[] getSavedReportCursors() throws Exception, altitude.integrationServer.exceptions.ISException
      Returns the saved report cursors open in the instance.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getSavedReportTableSchema

      TableSchema getSavedReportTableSchema() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the table schema of the saved report.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • newReportTemplateCursor

      IReportTemplateCursor newReportTemplateCursor(String[] columns, String sql) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens a report template cursor.
      Parameters:
      columns - Columns to fetch.
      sql - SQL.
      Returns:
      The IReportTemplateCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException

    • newSavedReportCursor

      ISavedReportCursor newSavedReportCursor(String[] columns, String sql) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens a saved report cursor.
      Parameters:
      columns - Columns to fetch.
      sql - SQL.
      Returns:
      The ISavedReportCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException

    • tryGetReportTemplateCursor

      IReportTemplateCursor tryGetReportTemplateCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a report template cursor open in the instance or null if it doesn't exist.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The IReportTemplateCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • tryGetSavedReportCursor

      ISavedReportCursor tryGetSavedReportCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a saved report cursor open in the instance or null if it doesn't exist.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The ISavedReportCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • updateSavedReport

      void updateSavedReport(String savedReportName, SavedReportUpdateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Updates a saved report.
      Parameters:
      savedReportName - Name of the saved report.
      request - Contains the fields to update.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException