com.genesyslab.platform.contacts.protocol.contactserver.requests
Class RequestRemoveDocument
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.RequestRemoveDocument
- 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 RequestRemoveDocument
- extends AbstractMessage
This request is intended to remove a document. 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.
Required parameters:
Related Events:
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. |
Field Summary |
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary |
java.util.Map |
attributes()
|
static RequestRemoveDocument |
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 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. |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
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. |
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
RequestRemoveDocument
public RequestRemoveDocument()
create
public static RequestRemoveDocument create()
getDocumentId
public java.lang.String getDocumentId()
- The Document which will be removed from database.
setDocumentId
public void setDocumentId(java.lang.String value)
- The Document which will be removed from database.
getInteractionId
public 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.
setInteractionId
public 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.
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.