Platform SDK Java 8.5 API Reference

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

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

This request is intended for changing interaction status.

Required parameters:

Name Description
setInteractionId(java.lang.String) Unique ID for the Interaction.
setTenantId(java.lang.Integer) Unique ID for the Tenant.
setStatus(com.genesyslab.platform.contacts.protocol.contactserver.Statuses) Status:
  • New - 0
  • Pending (IxnSvr) - 1
  • InProcess (IxnSvr) - 2
  • Stopped - 3

Related Events:
Name Description
EventSetInteractionStatus This event indicates that the interaction status has changed.
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
RequestSetInteractionStatus()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestSetInteractionStatus 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 getInteractionId()
          Unique Interaction ID.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 Statuses getStatus()
          Status: New - 0 Pending (IxnSvr) - 1 InProcess (IxnSvr) - 2 Stopped - 3
 java.lang.String getStoppedReason()
          Reason for status change.
 java.lang.String getSubscriberId()
          The subscriber (i.e. customer) within the tenant to which the interaction belongs to.
 java.lang.Integer getTenantId()
          Tenant ID.
 int hashCode()
           
 void setInteractionId(java.lang.String value)
          Unique Interaction ID.
 void setStatus(Statuses value)
          Status: New - 0 Pending (IxnSvr) - 1 InProcess (IxnSvr) - 2 Stopped - 3
 void setStoppedReason(java.lang.String value)
          Reason for status change.
 void setSubscriberId(java.lang.String value)
          The subscriber (i.e. customer) within the tenant to which the interaction belongs to.
 void setTenantId(java.lang.Integer value)
          Tenant ID.
 
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

RequestSetInteractionStatus

public RequestSetInteractionStatus()
Method Detail

create

public static RequestSetInteractionStatus create()

getInteractionId

public java.lang.String getInteractionId()
Unique Interaction ID.


setInteractionId

public void setInteractionId(java.lang.String value)
Unique Interaction ID.


getTenantId

public java.lang.Integer getTenantId()
Tenant ID.


setTenantId

public void setTenantId(java.lang.Integer value)
Tenant ID.


getSubscriberId

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


setSubscriberId

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


getStoppedReason

public java.lang.String getStoppedReason()
Reason for status change.


setStoppedReason

public void setStoppedReason(java.lang.String value)
Reason for status change.


getStatus

public Statuses getStatus()
Status:


setStatus

public void setStatus(Statuses value)
Status:


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.