com.genesyslab.platform.contacts.protocol.contactserver.requests
Class RequestAddDocument
java.lang.Object
com.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
com.genesyslab.platform.contacts.protocol.contactserver.requests.RequestAddDocument
- 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 RequestAddDocument
- extends AbstractMessage
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.
Required parameters:
Related Events:
Name |
Description |
EventAddDocument |
This event indicates that a document was successfully added
to an Interaction. |
EventError |
Indicates that the request encountered an error. |
Field Summary |
static int |
ID
|
static java.lang.String |
NAME
|
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 java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
ID
public static final int ID
- See Also:
- Constant Field Values
NAME
public static final java.lang.String NAME
- See Also:
- Constant Field Values
RequestAddDocument
public RequestAddDocument()
create
public static RequestAddDocument create()
getInteractionId
public java.lang.String getInteractionId()
setInteractionId
public void setInteractionId(java.lang.String value)
getDocumentId
public java.lang.String getDocumentId()
setDocumentId
public void setDocumentId(java.lang.String value)
getMimeType
public java.lang.String getMimeType()
setMimeType
public void setMimeType(java.lang.String value)
getTheName
public java.lang.String getTheName()
setTheName
public void setTheName(java.lang.String value)
getDescription
public java.lang.String getDescription()
setDescription
public void setDescription(java.lang.String value)
getTheSize
public java.lang.Integer getTheSize()
setTheSize
public void setTheSize(java.lang.Integer value)
getContent
public byte[] getContent()
setContent
public void setContent(byte[] value)
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
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.