|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IQueryResults
A handle used to retrieve a data engine query's results. A query results could contain multiple result sets. This is intended to be used by both Factory and Presentation Engines in BIRT, including later releases when a report document persists. Beyond Release 1, this would include methods to save and restore results in a persisted Report Document.
Method Summary | |
---|---|
void |
cancel()
Cancel the current operation. |
IPreparedQuery |
getPreparedQuery()
Returns the IPreparedQuery
that produced this instance. |
IResultIterator |
getResultIterator()
Returns the current result's iterator. |
IResultMetaData |
getResultMetaData()
Returns the metadata of the first or current result set This method provides the result metadata without having to first fetch the result data. |
Methods inherited from interface org.eclipse.birt.data.engine.api.IBaseQueryResults |
---|
close, getID |
Methods inherited from interface org.eclipse.birt.data.engine.api.INamedObject |
---|
getName, setName |
Method Detail |
---|
IPreparedQuery getPreparedQuery()
IPreparedQuery
that produced this instance.
IResultMetaData getResultMetaData() throws org.eclipse.birt.core.exception.BirtException
Returns Null if the metadata is not available before fetching
from an
IResultIterator
,
or if it is ambiguous on which result set to reference.
In such case, one should obtain the result metadata
from a specific IResultIterator
.
IQueryResults
. Null if not available or
ambiguous on which result set to reference.
org.eclipse.birt.data.engine.core.DataException
- if error occurs in Data Engine
org.eclipse.birt.core.exception.BirtException
IResultIterator getResultIterator() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.data.engine.core.DataException
- if error occurs in Data Engine
org.eclipse.birt.core.exception.BirtException
void cancel()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |