Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkCallback

All Known Implementing Classes:
DKCallbackIP

public interface dkCallback

This class defines an interface to the callback object.

IBM Confidential
5697-G29 and 5648-D03 (C) Copyright IBM Corp. 1994, 2000



Method Summary
 void cancelQuery()
          Indicates that the user has canceled the query.
 boolean dataCallback(dkCollection ddoList, boolean isDone)
          Returns nHits from the backend datastore
 int getThreshold()
          Gets the number of returned hits that the server return for each callback.
 void reportException(DKException exc)
          Report an exception from the backend datastore
 void setThreshold(int nValue)
          Sets the number of returned hits for each data callback.
 

Method Detail

setThreshold

public void setThreshold(int nValue)
Sets the number of returned hits for each data callback. This method should be set by applications for the datastore.
Parameters:
nValue - the number of hits in the result collection for each callback.

getThreshold

public int getThreshold()
Gets the number of returned hits that the server return for each callback. The datastore will call this method for each query.
Returns:
the threshold value,

cancelQuery

public void cancelQuery()
Indicates that the user has canceled the query. It should be called by the application to let the server knows to stop the query.

dataCallback

public boolean dataCallback(dkCollection ddoList,
                            boolean isDone)
Returns nHits from the backend datastore
Parameters:
ddoList - a collection of DKDDO objects
isDone - a boolean value indicating whether the server is done with the query. That is, there is more hits.
Returns:
true if query is done or user has canceled the query.

reportException

public void reportException(DKException exc)
Report an exception from the backend datastore
Parameters:
exc - an exception from the backend datastore

EIP Java APIs

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