|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.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.RequestStopInteraction
public final class RequestStopInteraction
This request is intended for stopping an Interaction.
Required parameters:
Name | Description |
---|---|
setInteractionId(java.lang.String) |
The unique interaction ID. |
setTenantId(java.lang.Integer) |
The unique tenant ID. |
Name | Description |
---|---|
EventStopInteraction |
Indicates that the interaction specified in the related
RequestStopInteraction has stopped correctly. |
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 | |
---|---|
RequestStopInteraction()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static RequestStopInteraction |
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.Boolean |
getDelete()
If "TRUE" and if the interaction has no child, then the specified interaction is deleted after processing stops. |
java.lang.String |
getInteractionId()
ID of the interaction to be stopped. |
java.lang.String |
getInteractionType()
Type of interaction to be stopped. |
java.lang.String |
getMediaType()
Media type for the interaction to be stopped. |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
KeyValueCollection |
getOtherFields()
A key-value collection of additional fields. |
java.lang.String |
getReason()
Reason that processing is being stopped for this interaction. |
java.lang.String |
getSubscriberId()
The subscriber (i.e. line of business) within the tenant to which the interaction belongs to. |
java.lang.Integer |
getTenantId()
Tenant ID of interaction to be stopped. |
int |
hashCode()
|
void |
setDelete(java.lang.Boolean value)
If "TRUE" and if the interaction has no child, then the specified interaction is deleted after processing stops. |
void |
setInteractionId(java.lang.String value)
ID of the interaction to be stopped. |
void |
setInteractionType(java.lang.String value)
Type of interaction to be stopped. |
void |
setMediaType(java.lang.String value)
Media type for the interaction to be stopped. |
void |
setOtherFields(KeyValueCollection value)
A key-value collection of additional fields. |
void |
setReason(java.lang.String value)
Reason that processing is being stopped for this interaction. |
void |
setSubscriberId(java.lang.String value)
The subscriber (i.e. line of business) within the tenant to which the interaction belongs to. |
void |
setTenantId(java.lang.Integer value)
Tenant ID of interaction to be stopped. |
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 |
---|
public static final int ID
public static final java.lang.String NAME
Constructor Detail |
---|
public RequestStopInteraction()
Method Detail |
---|
public static RequestStopInteraction create()
public java.lang.String getReason()
public void setReason(java.lang.String value)
public java.lang.Boolean getDelete()
public void setDelete(java.lang.Boolean value)
public java.lang.String getInteractionId()
public void setInteractionId(java.lang.String value)
public java.lang.String getInteractionType()
public void setInteractionType(java.lang.String value)
public java.lang.String getMediaType()
public void setMediaType(java.lang.String value)
public java.lang.Integer getTenantId()
public void setTenantId(java.lang.Integer value)
public java.lang.String getSubscriberId()
public void setSubscriberId(java.lang.String value)
public KeyValueCollection getOtherFields()
public void setOtherFields(KeyValueCollection value)
public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |