Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.events
Class EventAddDocument

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
              extended by com.genesyslab.platform.contacts.protocol.contactserver.events.EventAddDocument
All Implemented Interfaces:
EndpointSupport, ProtocolDescriptionSupport, Referenceable, com.genesyslab.platform.commons.protocol.runtime.DataSupport, com.genesyslab.platform.commons.protocol.runtime.UpdatableProtocolId, ContactServerMessage, Printable, RequestorInfoSupport

public final class EventAddDocument
extends AbstractMessage

This event indicates that a document was successfully added to an Interaction.

Selected Properties:

Name Description
getDocumentId() A unique ID of the added document. Only mandatory in "document creation mode".

Related Requests:
Name Description
RequestAddDocument This request is intended to add a document to an Interaction. This request can be used in 2 modes:

  • Link creation mode: UCS only creates an Attachment record to associate an existing Interaction (defined by the InteractionId parameter) to an existing Document (defined by the DocumentId parameter).
  • Document creation mode: UCS creates an Attachment record and a Document record and associates them to an existing Interaction (defined by the InteractionId parameter). The Document record is created using the parameters MimeType, TheName, Description, TheSize, Content. UCS returns the DocumentId in response.
UCS automatically works in "Link creation mode" when a parameter "DocumentId" is present in the request.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Fields inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
REF_ID_KEY
 
Constructor Summary
EventAddDocument()
           
 
Method Summary
 java.util.Map attributes()
           
static EventAddDocument create()
           
 com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
           
 boolean equals(java.lang.Object obj)
           
 java.util.Map getCompounds()
           
 java.util.List getCustomPackagers()
           
 java.lang.String getDocumentId()
          The ID of the new document.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 int hashCode()
           
 void setDocumentId(java.lang.String value)
          The ID of the new document.
 
Methods inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
getEndpoint, getLazyParser, getMessageAttribute, getProtocolId, getReferenceId, getRequestorInfo, retreiveReference, setEndpoint, setProtocolId, setReferenceId, setReferenceId, setRequestorInfo, toString, toString, toString, toString, updateReference
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getProtocolDescription, messageId, messageName, setProtocolDescription
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolDescriptionSupport
getProtocolDescription
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Constructor Detail

EventAddDocument

public EventAddDocument()
Method Detail

create

public static EventAddDocument create()

getDocumentId

public java.lang.String getDocumentId()
The ID of the new document.


setDocumentId

public void setDocumentId(java.lang.String value)
The ID of the new document.


getMetaData

public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()

getCustomPackagers

public java.util.List getCustomPackagers()
Specified by:
getCustomPackagers in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
Overrides:
getCustomPackagers in class AbstractMessage

attributes

public java.util.Map attributes()

getCompounds

public java.util.Map getCompounds()

createClone

public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)

hashCode

public int hashCode()
Overrides:
hashCode in class DataObject

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class DataObject

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.