BatchedResultObjectProvider (OpenJPA Parent POM 4.0.0 API)

All Superinterfaces:

Closeable, ResultObjectProvider

All Known Implementing Classes:

XROP
```
public interface BatchedResultObjectProvider
extends ResultObjectProvider
```
A provider for multiple result sets. This provider acts as a container of other result providers. The underlying providers contain the actual data and are iterated for the results, while this provider iterates over its underlying providers.
Designed for the specific purpose of getting results from the execution of Stored Procedures that can produce more than one result set and an optional update count. Few methods related to iterating multiple results and update count mirror the methods in JDBC Statement.

Author:

Pinaki Poddar

See Also:

QueryResultCallback

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`getExecutionResult()`	Gets the result of executing the underlying JDBC statement.
`java.lang.Object`	`getOut(int position)`
`java.lang.Object`	`getOut(java.lang.String name)`
`ResultObjectProvider`	`getResultObject()`	Gets the next result object provider from its batch.
`int`	`getUpdateCount()`	Gets the count of records updated by the underlying JDBC statement.
`boolean`	`hasMoreResults()`	Affirms if this batch contains more results.

Methods inherited from interface org.apache.openjpa.lib.rop.ResultObjectProvider
absolute, close, handleCheckedException, next, open, reset, size, supportsRandomAccess

- Method Detail
  - getResultObject
```
ResultObjectProvider getResultObject()
                              throws java.lang.Exception
```
    Gets the next result object provider from its batch.
    
    Specified by:
    
    getResultObject in interface ResultObjectProvider
    
    Throws:
    
    java.lang.Exception
  - hasMoreResults
```
boolean hasMoreResults()
```
    Affirms if this batch contains more results.
  - getExecutionResult
```
boolean getExecutionResult()
```
    Gets the result of executing the underlying JDBC statement.
    
    Returns:
    
    a boolean value whose semantics is same as PreparedStatement.execute().
  - getUpdateCount
```
int getUpdateCount()
```
    Gets the count of records updated by the underlying JDBC statement.
    
    Returns:
    
    an integer value whose semantics is same as Statement.getUpdateCount().
  - getOut
```
java.lang.Object getOut(java.lang.String name)
```
  - getOut
```
java.lang.Object getOut(int position)
```