Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBDocumentReplyEvent

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

public class CMBDocumentReplyEvent
extends CMBEventBase

Event for replying to document services requests. This event is emitted from CMBDocumentServices. Use CMBDocumentServices.addCMBDocumentReplyListener to register a listener. This event is only fired when the original request was initiated using CMBDocumentServices.onCMBDocumentRequest.

Since:
7.1
See Also:
CMBDocumentServices, CMBDocumentReplyListener, Serialized Form

Field Summary
static int CMB_REPLY_DROP_ALL_DOCUMENTS
          The event id for reply to a drop all documents request.
static int CMB_REPLY_DROP_DOCUMENT
          The event id for reply to a drop document request.
static int CMB_REPLY_LOAD_DOCUMENT
          The event id for reply to a load document request.
 
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
CMBDocumentReplyEvent(java.lang.Object source, int id, CMBDocument document)
          Construct a reply for load document request.
CMBDocumentReplyEvent(java.lang.Object source, int id, int status)
          Construct a reply for drop document or drop all documents requests.
 
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_LOAD_DOCUMENT

public static final int CMB_REPLY_LOAD_DOCUMENT
The event id for reply to a load document request.

CMB_REPLY_DROP_DOCUMENT

public static final int CMB_REPLY_DROP_DOCUMENT
The event id for reply to a drop document request.

CMB_REPLY_DROP_ALL_DOCUMENTS

public static final int CMB_REPLY_DROP_ALL_DOCUMENTS
The event id for reply to a drop all documents request.
Constructor Detail

CMBDocumentReplyEvent

public CMBDocumentReplyEvent(java.lang.Object source,
                             int id,
                             CMBDocument document)
Construct a reply for load document request.
Parameters:
source - the event source
id - the event type id (CMB_REPLY_LOAD_DOCUMENT)
document - the CMBDocument for the loaded document or null if document could not be loaded.

CMBDocumentReplyEvent

public CMBDocumentReplyEvent(java.lang.Object source,
                             int id,
                             int status)
Construct a reply for drop document or drop all documents requests.
Parameters:
source - the event source
id - the event type id (CMB_REPLY_DROP_DOCUMENT or CMB_REPLY_DROP_ALL_DOCUMENTS)
status - the status, either CMB_STATUS_OK or CMB_STATUS_FAILED.

EIP JavaBeans

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