com.ibm.mm.sdk.common
Class DKCallbackIP
java.lang.Object
|
+--com.ibm.mm.sdk.common.DKCallbackIP
- All Implemented Interfaces:
- dkCallback, DKConstant, DKConstantIP
- public class DKCallbackIP
- extends java.lang.Object
- implements dkCallback, DKConstantIP
This class defines an interface to the callback object.
IBM Confidential
5697-250, 5648-A08 and 5765-C86 (C) Copyright IBM Corp. 1994, 1997
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantIP |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
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. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
fOption
public int fOption
hSync
public int hSync
ulMsgId
public int ulMsgId
ulMsgparm1
public int ulMsgparm1
ulMsgparm2
public int ulMsgparm2
DKCallbackIP
public DKCallbackIP()
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.
- Specified by:
setThreshold
in interface dkCallback
- 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.
- Specified by:
getThreshold
in interface dkCallback
- 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.
- Specified by:
cancelQuery
in interface dkCallback
dataCallback
public boolean dataCallback(dkCollection ddoList,
boolean isDone)
- Returns nHits from the backend datastore
- Specified by:
dataCallback
in interface dkCallback
- Parameters:
ddoList
- a dkCollection of DKDDO objectsisDone
- 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
- Specified by:
reportException
in interface dkCallback
- Parameters:
exc
- an exception from the backend datastore
(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.