org.openliberty.arisid.stack
Interface IResultSet

public interface IResultSet

Method Summary

void	cancel() Cancel's the remaining results.
IGFException	getError() Returns the primary exception, if any, that may have occured producing the result set.
IDigitalSubject	getNext() Returns the next IDigitalSubject.
boolean	hasError() A boolean indicating if an error exists in the creation of the result set.
boolean	hasMore() Use to see if there are more results in the result set.
boolean	isPartial() A boolean indicating if the result set contains partial results.
void	registerResultListener(INextResultListener resultListener) To enable asynchronous processing of larger result sets, a client can elect to register an INextResultListener rather than polling isReady();

Method Detail

hasMore

boolean hasMore()

Use to see if there are more results in the result set.

Returns:

true if there are more results in the result set to be returned.

getNext

IDigitalSubject getNext()
                        throws MappingException,
                               ConnectionException,
                               IGFException

Returns the next IDigitalSubject. If no result is available, the thread will hang until one is returned. Use registerResultListener(INextResultListener) to enable asynchronous processing and event notification.

Returns:

the next IDigitalSubject

Throws:

MappingException

ConnectionException

IGFException

cancel

void cancel()

Cancel's the remaining results.

isPartial

boolean isPartial()

A boolean indicating if the result set contains partial results.

Returns:

true if partial results returned. See getError().

hasError

boolean hasError()

A boolean indicating if an error exists in the creation of the result set.

Returns:

true if an error condition exists.

getError

IGFException getError()

Returns the primary exception, if any, that may have occured producing the result set.

Returns:

Exception generated as a result of producing the result set.

registerResultListener

void registerResultListener(INextResultListener resultListener)

To enable asynchronous processing of larger result sets, a client can elect to register an INextResultListener rather than polling isReady();

Parameters:

resultListener -