Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.data.engine.api
Interface IBaseQueryResults

All Superinterfaces:
  INamedObject

All Known Subinterfaces:
  IQueryResults

    public interface IBaseQueryResults

extends INamedObject

The new IBaseQueryResults is an interface which will be extends by IQueryResults and ICubeQueryResults interfaces. It provides service for client to get/set query results id.

Method Summary
`void` | `close()` Closes all query result set(s) associated with this object; provides a hint to the query that it can safely release all associated resources.
`java.lang.String` | `getID()` Every query results has a unique id.

Methods inherited from interface org.eclipse.birt.data.engine.api.INamedObject
`getName, setName`

Method Detail

### getID

    java.lang.String getID()

  Every query results has a unique id. This ID will be used to retrieve a stored query results from report document. Meantime, it might be used as a data source ID to define a query definition.

  Returns:
    a unique ID

### close

    void close()
               throws org.eclipse.birt.core.exception.BirtException

  Closes all query result set(s) associated with this object; provides a hint to the query that it can safely release all associated resources. The query results might have iterators open on them. Iterators associated with the query result sets are invalidated and can no longer be used.

  Throws:
    `org.eclipse.birt.core.exception.BirtException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.