Platform SDK Java 8.5 API Reference

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

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

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.

Related Events:
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

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

RequestStopInteraction

public RequestStopInteraction()
Method Detail

create

public static RequestStopInteraction create()

getReason

public java.lang.String getReason()
Reason that processing is being stopped for this interaction.


setReason

public void setReason(java.lang.String value)
Reason that processing is being stopped for this interaction.


getDelete

public java.lang.Boolean getDelete()
If "TRUE" and if the interaction has no child, then the specified interaction is deleted after processing stops. Default value is "FALSE".


setDelete

public void setDelete(java.lang.Boolean value)
If "TRUE" and if the interaction has no child, then the specified interaction is deleted after processing stops. Default value is "FALSE".


getInteractionId

public java.lang.String getInteractionId()
ID of the interaction to be stopped.


setInteractionId

public void setInteractionId(java.lang.String value)
ID of the interaction to be stopped.


getInteractionType

public java.lang.String getInteractionType()
Type of interaction to be stopped.


setInteractionType

public void setInteractionType(java.lang.String value)
Type of interaction to be stopped.


getMediaType

public java.lang.String getMediaType()
Media type for the interaction to be stopped.


setMediaType

public void setMediaType(java.lang.String value)
Media type for the interaction to be stopped.


getTenantId

public java.lang.Integer getTenantId()
Tenant ID of interaction to be stopped.


setTenantId

public void setTenantId(java.lang.Integer value)
Tenant ID of interaction to be stopped.


getSubscriberId

public java.lang.String getSubscriberId()
The subscriber (i.e. line of business) within the tenant to which the interaction belongs to.


setSubscriberId

public void setSubscriberId(java.lang.String value)
The subscriber (i.e. line of business) within the tenant to which the interaction belongs to.


getOtherFields

public KeyValueCollection getOtherFields()
A key-value collection of additional fields.


setOtherFields

public void setOtherFields(KeyValueCollection value)
A key-value collection of additional fields.


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.