Platform SDK Java 8.5 API Reference

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

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

This request is intended for updating of interaction attributes and binary content.

Required parameters:

Name Description
setInteractionAttributes(com.genesyslab.platform.contacts.protocol.contactserver.InteractionAttributes) The list of Attributes and their values, which have to be updated.
setEntityAttributes(com.genesyslab.platform.contacts.protocol.contactserver.BaseEntityAttributes) The list of Entity-specific attributes and their values, which have to be updated.

Related Events:
Name Description
EventUpdateInteraction This event indicates that the interaction attributes and binary content were updated 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
RequestUpdateInteraction()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestUpdateInteraction create()
           
 com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
           
 boolean equals(java.lang.Object obj)
           
 CoBrowseAction getAction()
          Applicable to CoBrowse records.
"Add": CoBrowseURL records are added to current records. "Replace": CoBrowseURL records replace current records. "Remove": CoBrowseURL records will be removed.
 java.util.Map getCompounds()
           
 java.util.List getCustomPackagers()
           
 BaseEntityAttributes getEntityAttributes()
          The list of Entity specific attributes and their values, which have to be updated.

Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction.
 InteractionAttributes getInteractionAttributes()
          The list of attributes and their values, which have to be updated.

If MediaServer specific parameters must be updated, then EntityTypeId is also required.

Attributes which are declared as mandatory in RequestInsertInteraction description and attributes CanBeParent, CreatorAppId, StartDate must have a not null value if passed in UpdateInteraction.

Id and TenantId are mandatory attributes.

EntityTypeId is required if MediaServer specific parameters are updated.

Id, TenantId, and EntityTypeId are immutable attributes.
 InteractionContent getInteractionContent()
          Information to update binary content.

Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 int hashCode()
           
 void setAction(CoBrowseAction value)
          Applicable to CoBrowse records.
"Add": CoBrowseURL records are added to current records. "Replace": CoBrowseURL records replace current records. "Remove": CoBrowseURL records will be removed.
 void setEntityAttributes(BaseEntityAttributes value)
          The list of Entity specific attributes and their values, which have to be updated.

Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction.
 void setInteractionAttributes(InteractionAttributes value)
          The list of attributes and their values, which have to be updated.

If MediaServer specific parameters must be updated, then EntityTypeId is also required.

Attributes which are declared as mandatory in RequestInsertInteraction description and attributes CanBeParent, CreatorAppId, StartDate must have a not null value if passed in UpdateInteraction.

Id and TenantId are mandatory attributes.

EntityTypeId is required if MediaServer specific parameters are updated.

Id, TenantId, and EntityTypeId are immutable attributes.
 void setInteractionContent(InteractionContent value)
          Information to update binary content.

Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction.
 
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

RequestUpdateInteraction

public RequestUpdateInteraction()
Method Detail

create

public static RequestUpdateInteraction create()

getInteractionAttributes

public InteractionAttributes getInteractionAttributes()
The list of attributes and their values, which have to be updated.

If MediaServer specific parameters must be updated, then EntityTypeId is also required.

Attributes which are declared as mandatory in RequestInsertInteraction description and attributes CanBeParent, CreatorAppId, StartDate must have a not null value if passed in UpdateInteraction.

Id and TenantId are mandatory attributes.

EntityTypeId is required if MediaServer specific parameters are updated.

Id, TenantId, and EntityTypeId are immutable attributes. They should never be set to a new value.


setInteractionAttributes

public void setInteractionAttributes(InteractionAttributes value)
The list of attributes and their values, which have to be updated.

If MediaServer specific parameters must be updated, then EntityTypeId is also required.

Attributes which are declared as mandatory in RequestInsertInteraction description and attributes CanBeParent, CreatorAppId, StartDate must have a not null value if passed in UpdateInteraction.

Id and TenantId are mandatory attributes.

EntityTypeId is required if MediaServer specific parameters are updated.

Id, TenantId, and EntityTypeId are immutable attributes. They should never be set to a new value.


getInteractionContent

public InteractionContent getInteractionContent()
Information to update binary content.

Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction.


setInteractionContent

public void setInteractionContent(InteractionContent value)
Information to update binary content.

Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction.


getEntityAttributes

public BaseEntityAttributes getEntityAttributes()
The list of Entity specific attributes and their values, which have to be updated.

Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction.


setEntityAttributes

public void setEntityAttributes(BaseEntityAttributes value)
The list of Entity specific attributes and their values, which have to be updated.

Attributes which are declared as mandatory in RequestInsertInteraction description must have a not null value if passed in UpdateInteraction.


getAction

public CoBrowseAction getAction()
Applicable to CoBrowse records.


setAction

public void setAction(CoBrowseAction value)
Applicable to CoBrowse records.


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.