Interface ReportDestination

  • All Superinterfaces:
    APIResultSetCallback

    public interface ReportDestination
    extends APIResultSetCallback
    A destination for report results. Report destinations will format report data in a particular output format, for example HTML or CSV.
    • Method Detail

      • callback

        boolean callback​(ReportResultSet rs,
                         ObjectGetter objectGetter)
                  throws SQLException
        Call back used to format a row.
        Parameters:
        rs - the report result set positioned at the row to format.
        objectGetter - an interface to allow objects to be retrieved.
        Returns:
        true to continue, false otherwise.
        Throws:
        SQLException - if an error occurs.
      • postExecute

        void postExecute​(ReportResultSet rs)
                  throws SQLException
        Process the result set before the initial ResultSet.next() is called. This should be used to handle the cases where the result set is empty but result information is still required - e.g. displaying the headers for an empty result.
        Parameters:
        rs - the ResultSet row to process
        Throws:
        SQLException - if an error occurs.
      • getRows

        int getRows()
        Get the number rows in the report result set.
        Returns:
        the number of rows