Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.requests
Class RequestAddDocument

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.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:

UCS automatically works in "Link creation mode" when a parameter "DocumentId" is present in the request.

Required parameters:
Name Description
setInteractionId(java.lang.String) The unique ID of the Interaction.
setDocumentId(java.lang.String) The unique ID of the Document. Maximum length is 16 characters. Only mandatory for "link creation mode".
setMimeType(java.lang.String) String value specifying the MIME type for this attachment. Maximum length is 256 characters. Only mandatory for "document creation mode".
setTheName(java.lang.String) The name of the attachment. Maximum length is 256 characters. Only mandatory for "document creation mode".
setTheSize(java.lang.Integer) The size of the attachment. Only mandatory for "document creation mode".

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
           
 
Fields inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
REF_ID_KEY
 
Constructor Summary
RequestAddDocument()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestAddDocument 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()
           
 byte[] getContent()
           
 java.util.List getCustomPackagers()
           
 java.lang.String getDescription()
           
 java.lang.String getDocumentId()
           
 java.lang.String getInteractionId()
           
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.String getMimeType()
           
 java.lang.String getTheName()
           
 java.lang.Integer getTheSize()
           
 int hashCode()
           
 void setContent(byte[] value)
           
 void setDescription(java.lang.String value)
           
 void setDocumentId(java.lang.String value)
           
 void setInteractionId(java.lang.String value)
           
 void setMimeType(java.lang.String value)
           
 void setTheName(java.lang.String value)
           
 void setTheSize(java.lang.Integer value)
           
 
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

RequestAddDocument

public RequestAddDocument()
Method Detail

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

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.