Platform SDK Java 8.5 API Reference

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

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.RequestUpdateDocument
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 RequestUpdateDocument
extends AbstractMessage

This request is intended to update a document.

Required parameters:

Name Description
setDocumentId(java.lang.String) The unique ID of the Document that will be updated.

Related Events:
Name Description
EventUpdateDocument This event indicates that the specified document was updated successfully.
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
RequestUpdateDocument()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestUpdateDocument 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()
          Document ID.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.String getMimeType()
          Cannot be null if present.
 java.lang.String getTheName()
          Cannot be null if present.
 java.lang.Integer getTheSize()
          Cannot be null if present.
 int hashCode()
           
 void setContent(byte[] value)
           
 void setDescription(java.lang.String value)
           
 void setDocumentId(java.lang.String value)
          Document ID.
 void setMimeType(java.lang.String value)
          Cannot be null if present.
 void setTheName(java.lang.String value)
          Cannot be null if present.
 void setTheSize(java.lang.Integer value)
          Cannot be null if present.
 
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

RequestUpdateDocument

public RequestUpdateDocument()
Method Detail

create

public static RequestUpdateDocument create()

getDocumentId

public java.lang.String getDocumentId()
Document ID.


setDocumentId

public void setDocumentId(java.lang.String value)
Document ID.


getMimeType

public java.lang.String getMimeType()
Cannot be null if present.


setMimeType

public void setMimeType(java.lang.String value)
Cannot be null if present.


getTheName

public java.lang.String getTheName()
Cannot be null if present.


setTheName

public void setTheName(java.lang.String value)
Cannot be null if present.


getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String value)

getTheSize

public java.lang.Integer getTheSize()
Cannot be null if present.


setTheSize

public void setTheSize(java.lang.Integer value)
Cannot be null if present.


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.