Package com.redwood.scheduler.api.model

Class StringCallback

java.lang.Object

com.redwood.scheduler.api.model.StringCallback

All Implemented Interfaces:

APIResultSetCallback

public class StringCallback
extends Object
implements APIResultSetCallback

Use this callback if you have a query which selects 1 String column and the query returns 1 row (result). For example: select j.Description from Job j where j.UniqueId=1

Field Summary

Fields inherited from interface com.redwood.scheduler.api.model.APIResultSetCallback

NULL

Constructor Summary

Constructors

Constructor	Description
StringCallback()

Method Summary

Modifier and Type	Method	Description
boolean	callback(ResultSet rs, ObjectGetter ignored)	Invoked for each result, provided that the previous invocation returned true.
String	getResult()	Return the result read from the query.
void	start()	Invoked before processing any results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.redwood.scheduler.api.model.APIResultSetCallback

finish

Constructor Detail

StringCallback

public StringCallback()

Method Detail

callback

public boolean callback(ResultSet rs,
                        ObjectGetter ignored)
                 throws SQLException

Description copied from interface: APIResultSetCallback

Invoked for each result, provided that the previous invocation returned true.

Specified by:

callback in interface APIResultSetCallback

Parameters:

rs - the result-set to process

ignored - an object-getter with can be used to convert the result-set into one (or more) objects.

Returns:

true if this method should be invoked for the next result, false if subsequent results are to be discarded.

Throws:

SQLException - Exception thrown when a database-related error occurs

start

public void start()

Description copied from interface: APIResultSetCallback

Invoked before processing any results.

This is before any calls to APIResultSetCallback.callback(ResultSet, ObjectGetter) are made.

Note that this may be invoked more than once under some circumstances. (Such circumstances include when the query is restarted due to underlying database errors.)

Specified by:

start in interface APIResultSetCallback

getResult

public String getResult()

Return the result read from the query.

Returns:

The result from the query