Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkQueryBase

All Known Subinterfaces:
dkPersistentQuery, dkQuery
All Known Implementing Classes:
DKCombinedQueryOptDL, DKCombinedQueryDL

public interface dkQueryBase

dkQuerybase is an interface for a query object that can be associated with zero or more datastores. With the help of its datastores, query objects perform query processing tasks, such as preparing and running a query, monitoring the status of queries, and storing the results. The result of a query is returned as an Object that you cast to DKResults.


Method Summary
 void execute(DKNVPair[] params)
          executes the query
 int numberOfResults()
          Gets the number of query results
 void prepare(DKNVPair[] params)
          prepares the query
 java.lang.Object result()
          get the query results
 dkResultSetCursor resultSetCursor()
          get the query results
 int status()
          gets the query status
 

Method Detail

prepare

public void prepare(DKNVPair[] params)
             throws DKException,
                    java.lang.Exception
prepares the query
Parameters:
params - additional prepare query option in name/value pair

execute

public void execute(DKNVPair[] params)
             throws DKException,
                    java.lang.Exception
executes the query
Parameters:
params - additional query option in name/value pair

status

public int status()
gets the query status
Returns:
query status

result

public java.lang.Object result()
                        throws DKException,
                               java.lang.Exception
get the query results
Returns:
query result in a DKResults object

resultSetCursor

public dkResultSetCursor resultSetCursor()
                                  throws DKException,
                                         java.lang.Exception
get the query results
Returns:
query result in a dkResultSetCursor object

numberOfResults

public int numberOfResults()
Gets the number of query results
Returns:
number of query results

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.