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

Interface ReportResultSet

public interface ReportResultSet

Row Result of a report execution.

Method Summary

Modifier and Type	Method	Description
BigDecimal	getBigDecimal(int column)	Get the value of the specified numeric column.
Map<String,Object>	getFormatParameters()	Get the parameters used for formatting.
int	getInt(int column)	Get the value of the specified numeric column.
long	getLong(int column)	Get the value of the specified Long column.
long	getLong(String columnName)	Get the value of the specified Long column.
ReportResultSetMetaData	getMetaData()	Get the meta data for this result set.
String	getString(int column)	Get the value of the specified String column.
boolean	wasNull()	Was the previous call to getLong() or getString() a null?

Method Detail

getMetaData

ReportResultSetMetaData getMetaData()
                             throws SQLException

Get the meta data for this result set.

Returns:

the meta data.

Throws:

SQLException - if an error occurs.

getString

String getString(int column)
          throws SQLException

Get the value of the specified String column.

Parameters:

column - the column index (1 based).

Returns:

the value.

Throws:

SQLException - if an error occurs.

getLong

long getLong(int column)
      throws SQLException

Get the value of the specified Long column.

Parameters:

column - the column index (1 based).

Returns:

the value.

Throws:

SQLException - if an error occurs.

wasNull

boolean wasNull()
         throws SQLException

Was the previous call to getLong() or getString() a null?

Returns:

true if it was, false otherwise.

Throws:

SQLException

getLong

long getLong(String columnName)
      throws SQLException

Get the value of the specified Long column.

Parameters:

columnName - the column name.

Returns:

the value.

Throws:

SQLException - if an error occurs.

getBigDecimal

BigDecimal getBigDecimal(int column)
                  throws SQLException

Get the value of the specified numeric column.

Parameters:

column - the column index (1 based).

Returns:

the value.

Throws:

SQLException - if an error occurs.

getInt

int getInt(int column)
    throws SQLException

Get the value of the specified numeric column.

Parameters:

column - the column index (1 based).

Returns:

the value.

Throws:

SQLException - if an error occurs.

getFormatParameters

Map<String,Object> getFormatParameters()

Get the parameters used for formatting. This is the list of job parameters passed to the report and a list of System_<ColumnOrder>_format parameters.

Returns:

the map of formatting parameters