Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBSearchReplyEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.mm.beans.CMBEventBase
              |
              +--com.ibm.mm.beans.CMBSearchReplyEvent
All Implemented Interfaces:
CMBBaseConstant, java.io.Serializable

public class CMBSearchReplyEvent
extends CMBEventBase

Event for replying to search requests.

Since:
6.1
See Also:
CMBQueryService, CMBSearchTemplate, CMBSearchReplyListener, Serialized Form

Field Summary
static int CMB_REPLY_CANCEL_SEARCH
           
static int CMB_REPLY_SEARCH_ASYNCH
           
static int CMB_REPLY_SEARCH_SYNCH
           
static int CMB_REPLY_SEARCH_SYNCH_CURSOR
           
 
Fields inherited from class com.ibm.mm.beans.CMBEventBase
CMB_REPLY_NO_CONNECTION
 
Fields inherited from class java.util.EventObject
source
 
Fields inherited from interface com.ibm.mm.beans.CMBBaseConstant
ANNOTATION_MIME_TYPE, CMB_CLASS_ICM_DOC_MODEL, CMB_CLASS_ICM_DOC_PART, CMB_CLASS_ITEM, CMB_CLASS_RESOURCE_ITEM, CMB_CLASS_UNDEFINED, CMB_CONNTYPE_DYNAMIC, CMB_CONNTYPE_LOCAL, CMB_CONNTYPE_REMOTE, CMB_CONTENT_ATTRONLY, CMB_CONTENT_CHILDREN, CMB_CONTENT_ITEMTREE, CMB_CONTENT_LINKS_INBOUND, CMB_CONTENT_LINKS_OUTBOUND, CMB_CONTENT_YES, CMB_DATATYPE_COLLECTION, CMB_DATATYPE_COLLECTION_DDO, CMB_DATATYPE_COLLECTION_XDO, CMB_DATATYPE_DATAOBJECTBASE, CMB_DATATYPE_DATE, CMB_DATATYPE_DECIMAL, CMB_DATATYPE_DOUBLE, CMB_DATATYPE_FLOAT, CMB_DATATYPE_FSTRING, CMB_DATATYPE_ITEM, CMB_DATATYPE_ITEM_COLLECTION, CMB_DATATYPE_LONG, CMB_DATATYPE_OBJECT, CMB_DATATYPE_OBJECT_COLLECTION, CMB_DATATYPE_SHORT, CMB_DATATYPE_TIME, CMB_DATATYPE_TIMESTAMP, CMB_DATATYPE_UNDEFINED, CMB_DATATYPE_VSTRING, CMB_DSTYPE_CM, CMB_DSTYPE_DB2, CMB_DSTYPE_DES, CMB_DSTYPE_DJ, CMB_DSTYPE_DL, CMB_DSTYPE_DOMDOC, CMB_DSTYPE_FED, CMB_DSTYPE_FN, CMB_DSTYPE_IC, CMB_DSTYPE_ICM, CMB_DSTYPE_IP390, CMB_DSTYPE_JDBC, CMB_DSTYPE_OD, CMB_DSTYPE_VI400, CMB_EIP_LOGOUT, CMB_OBJTYPE_CMBITEM, CMB_OBJTYPE_CMBOBJECT, CMB_OP_AND, CMB_OP_BETWEEN, CMB_OP_CONTAINS_TEXT, CMB_OP_CONTAINS_TEXT_IN_CONTENT, CMB_OP_EQUAL, CMB_OP_GREATER, CMB_OP_GREATER_EQUAL, CMB_OP_IN, CMB_OP_LESS, CMB_OP_LESS_EQUAL, CMB_OP_LIKE, CMB_OP_NOT, CMB_OP_NOT_BETWEEN, CMB_OP_NOT_EQUAL, CMB_OP_NOT_IN, CMB_OP_NOT_LIKE, CMB_OP_OR, CMB_OP_UNDEFINED, CMB_QS_TYPE_COMBINED, CMB_QS_TYPE_DES, CMB_QS_TYPE_FEDERATED, CMB_QS_TYPE_IMAGE, CMB_QS_TYPE_PARAMETRIC, CMB_QS_TYPE_SQL, CMB_QS_TYPE_TEMPLATE, CMB_QS_TYPE_TEXT, CMB_QS_TYPE_UNKNOWN, CMB_QS_TYPE_XPATH, CMB_ST_SKIP_ALWAYS, CMB_ST_SKIP_NEVER, CMB_ST_SKIP_WITH_PROMPT, CMB_STATUS_FAILED, CMB_STATUS_OK, CMB_STATUS_RESULT_END, CMB_STATUS_RESULT_MORE, CMB_STATUS_RESULT_NEW, CMB_TIMESTAMP_UNDEFINED, CMB_TYPE_DOCUMENT, CMB_TYPE_FOLDER, CMB_TYPE_ITEM, CMB_TYPE_UNKNOWN, CMB_USERID_UNDEFINED, CMB_VERSION_CONTROL_ALWAYS_NEW, CMB_VERSION_CONTROL_BY_APP, CMB_VERSION_CONTROL_NEVER, CMB_VERSION_KEYWORD, CMB_VERSION_LATEST, CMB_VERSION_NEW, PROP_CACHE_ENABLED, PROP_CC2MIME_URL, PROP_CONNECTION, PROP_CONNECTION_TYPE, PROP_DATA_MANAGEMENT_ENABLED, PROP_DSTYPE, PROP_LOCAL_SERVER, PROP_NAME, PROP_NEW_PASSWORD, PROP_PASSWORD, PROP_PORT_NUMBER, PROP_QUERY_CALLBACK_THRESHOLD, PROP_QUERY_MAX_RESULTS, PROP_RESULT_PAGESIZE, PROP_RMI_HOSTNAME, PROP_SCHEMA_MANAGEMENT_ENABLED, PROP_SEARCH_ASYNCH, PROP_SEARCH_MULTI_CHARS_WILDCARD, PROP_SEARCH_PARAMETRIC_WILDCARD, PROP_SEARCH_SINGLE_CHAR_WILDCARD, PROP_SEARCH_SKIP_SERVER, PROP_SEARCH_TIMEOUT, PROP_SERVER_NAME, PROP_SV_CONNECTION_TYPE, PROP_SV_PORT_NUMBER, PROP_SV_RMI_HOSTNAME, PROP_TRACE_ENABLED, PROP_USERID
 
Constructor Summary
CMBSearchReplyEvent(java.lang.Object source, int id, java.lang.Exception data)
          Reply a failed request, exception object provided.
CMBSearchReplyEvent(java.lang.Object source, int id, int status)
          Construct a CMBSearchReplyEvent, result data provided.
CMBSearchReplyEvent(java.lang.Object source, int id, int status, java.lang.Object data)
          Reply a succeeded request, result data provided.
CMBSearchReplyEvent(java.lang.Object source, int id, int status, java.lang.Object data, java.lang.Object extraData)
          Reply a failed request, exception object provided.
 
Methods inherited from class com.ibm.mm.beans.CMBEventBase
getData, getExtraData, getID, getStatus
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CMB_REPLY_SEARCH_ASYNCH

public static final int CMB_REPLY_SEARCH_ASYNCH

CMB_REPLY_SEARCH_SYNCH

public static final int CMB_REPLY_SEARCH_SYNCH

CMB_REPLY_SEARCH_SYNCH_CURSOR

public static final int CMB_REPLY_SEARCH_SYNCH_CURSOR

CMB_REPLY_CANCEL_SEARCH

public static final int CMB_REPLY_CANCEL_SEARCH
Constructor Detail

CMBSearchReplyEvent

public CMBSearchReplyEvent(java.lang.Object source,
                           int id,
                           int status)
Construct a CMBSearchReplyEvent, result data provided.
Parameters:
source - the event source
id - the event type id
status - the reply status

CMBSearchReplyEvent

public CMBSearchReplyEvent(java.lang.Object source,
                           int id,
                           int status,
                           java.lang.Object data)
Reply a succeeded request, result data provided.
Parameters:
source - the event source
id - the event type id
data - search result data, can be:
                   1. Vector, the complete or partial hitlist (DKDDO)
                      if event type == CMB_REPLY_SEARCH_ASYNCH &&
                         status == CMB_STATUS_RESULT_NEW, MORE, END
                      or
                      if event type == CMB_REPLY_SEARCH_SYNCH  &&
                         status == CMB_STATUS_RESULT_NEW (implies END)
                   2. dkResultSetCursor, the result set cursor, may conatin
                      0 item if no match
                      if event type == CMB_REPLY_SEARCH_SYNCH_CURSOR &&
                         status == CMB_STATUS_RESULT_NEW (implies END)
  

CMBSearchReplyEvent

public CMBSearchReplyEvent(java.lang.Object source,
                           int id,
                           java.lang.Exception data)
Reply a failed request, exception object provided.
Parameters:
source - the event source
id - the event type id
data - the exception object

CMBSearchReplyEvent

public CMBSearchReplyEvent(java.lang.Object source,
                           int id,
                           int status,
                           java.lang.Object data,
                           java.lang.Object extraData)
Reply a failed request, exception object provided.
Parameters:
source - the event source
id - the event type id
status - the event status
data - the exception message
extraData - the exception object

EIP JavaBeans

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