EndpointSupport
, ProtocolDescriptionSupport
, Referenceable
, DataSupport
, ContactServerMessage
, Printable
, RequestorInfoSupport
public final class RequestRemoveDocument extends AbstractMessage
Name | Description |
---|---|
setDocumentId(java.lang.String) |
The unique ID of the Document that will be removed from database. |
Name | Description |
---|---|
EventRemoveDocument |
This event indicates that a Document was successfully removed. If the related Document is no more referenced by any Attachment (no more associated to any Interaction or StandardResponse), the Document record is also removed from database. |
EventError |
Indicates that the request encountered an error. |
Modifier and Type | Field | Description |
---|---|---|
static int |
ID |
|
static java.lang.String |
NAME |
REF_ID_KEY
Constructor | Description |
---|---|
RequestRemoveDocument() |
Modifier and Type | Method | Description |
---|---|---|
java.util.Map |
attributes() |
|
static RequestRemoveDocument |
create() |
|
DataSupport |
createClone(DataSupport sample) |
|
Message |
createEspMessage() |
For internal usage only
|
boolean |
equals(java.lang.Object obj) |
|
java.util.Map |
getCompounds() |
|
java.util.List |
getCustomPackagers() |
|
java.lang.String |
getDocumentId() |
The Document which will be removed from database.
|
java.lang.String |
getInteractionId() |
If InteractionId parameter is available, all links from this Interaction
to the specified Document are removed.
Otherwise, all links from all Interactions to this Document are removed, and the Document itself is also removed. |
java.lang.String |
getMessageCategory() |
For internal usage only
|
MetaData |
getMetaData() |
|
java.lang.String |
getMethod() |
For internal usage only
|
java.lang.String |
getMethodKey() |
For internal usage only
|
java.lang.String |
getService() |
For internal usage only
|
int |
hashCode() |
|
void |
setDocumentId(java.lang.String value) |
The Document which will be removed from database.
|
void |
setInteractionId(java.lang.String value) |
If InteractionId parameter is available, all links from this Interaction
to the specified Document are removed.
Otherwise, all links from all Interactions to this Document are removed, and the Document itself is also removed. |
getEndpoint, getLazyParser, getMessageAttribute, getProtocolId, getReferenceId, getRequestorInfo, retreiveReference, setEndpoint, setProtocolId, setReferenceId, setReferenceId, setRequestorInfo, toString, toString, toString, toString, updateReference
cloneMessage, getProtocolDescription, messageId, messageName, setProtocolDescription
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getProtocolDescription
public static final int ID
public static final java.lang.String NAME
public static RequestRemoveDocument create()
public java.lang.String getMethodKey()
AbstractMessage
getMethodKey
in class AbstractMessage
public java.lang.String getService()
AbstractMessage
getService
in class AbstractMessage
public java.lang.String getMethod()
AbstractMessage
getMethod
in class AbstractMessage
public java.lang.String getMessageCategory()
AbstractMessage
getMessageCategory
in class AbstractMessage
public Message createEspMessage()
AbstractMessage
createEspMessage
in class AbstractMessage
public java.lang.String getDocumentId()
public void setDocumentId(java.lang.String value)
public java.lang.String getInteractionId()
public void setInteractionId(java.lang.String value)
public MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public DataSupport createClone(DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.