Package com.redwood.scheduler.api.model.report

Interface ReportResultSetMetaData

  • public interface ReportResultSetMetaData
    Meta data of a report execution.

    • Method Detail

      • getColumnCount

        int getColumnCount()
            throws SQLException
        Get the number of columns in the result set.
        Returns:
        the number of columns
        Throws:
        SQLException - if an error occurs.

      • getColumnLabel

        String getColumnLabel​(int column)
               throws SQLException
        Get the label for the specified column (1 based). The label is free text.
        Parameters:
        column - the column number (1 based)
        Returns:
        the label.
        Throws:
        SQLException - if an error occurs.

      • getColumnFormat

        com.redwood.scheduler.api.model.enumeration.ReportColumnFormat getColumnFormat​(int column)
        Return the format type for the column output
        Parameters:
        column - the column index
        Returns:
        the format

      • getColumnClassName

        String getColumnClassName​(int column)
                   throws SQLException
        Get the class name for the specified column (1 based). This is in the format Object.Field where Object is a model object (eg. Job or JobDefinition) and Field is a database field of that object.
        Parameters:
        column - the column number (1 based)
        Returns:
        the label.
        Throws:
        SQLException - if an error occurs.

      • getColumnAlias

        String getColumnAlias​(int column)
               throws SQLException
        Get the alias for the column, if there is no alias return the full column name
        Parameters:
        column - the column number (1 based)
        Returns:
        the alias.
        Throws:
        SQLException - if an error occurs.