Platform SDK Java 8.5 API Reference

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

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

This request is intended for updating contact attributes. New attributes can be added or existing attributes can be updated or removed.

Required parameters:

Name Description
setContactId(java.lang.String) A unique ID for the contact whose attributes are to be created, updated, or deleted.
setTenantId(java.lang.Integer) Integer value specifying the tenant.

Related Events:
Name Description
EventUpdateAttributes Indicates that the related RequestUpdateAttributes was successful.
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
RequestUpdateAttributes()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestUpdateAttributes 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.lang.String getContactId()
          ID for the contact which attributes will be created, updated, or deleted.
 java.util.List getCustomPackagers()
           
 DeleteAttributesList getDeleteAttributes()
          A key-value list with attributes that will be deleted from this contact.
 AttributesList getInsertAttributes()
          A key-value list with attributes that will be inserted into this contact.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.String getSubscriberId()
          The subscriber (i.e. line of business) within the tenant to which the contact belongs to.
 java.lang.Integer getTenantId()
          Tenant ID.
 AttributesList getUpdateAttributes()
          A key-value list with attributes that will be update for this contact.
 int hashCode()
           
 void setContactId(java.lang.String value)
          ID for the contact which attributes will be created, updated, or deleted.
 void setDeleteAttributes(DeleteAttributesList value)
          A key-value list with attributes that will be deleted from this contact.
 void setInsertAttributes(AttributesList value)
          A key-value list with attributes that will be inserted into this contact.
 void setSubscriberId(java.lang.String value)
          The subscriber (i.e. line of business) within the tenant to which the contact belongs to.
 void setTenantId(java.lang.Integer value)
          Tenant ID.
 void setUpdateAttributes(AttributesList value)
          A key-value list with attributes that will be update for this contact.
 
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

RequestUpdateAttributes

public RequestUpdateAttributes()
Method Detail

create

public static RequestUpdateAttributes create()

getContactId

public java.lang.String getContactId()
ID for the contact which attributes will be created, updated, or deleted.


setContactId

public void setContactId(java.lang.String value)
ID for the contact which attributes will be created, updated, or deleted.


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. line of business) within the tenant to which the contact belongs to.


setSubscriberId

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


getDeleteAttributes

public DeleteAttributesList getDeleteAttributes()
A key-value list with attributes that will be deleted from this contact.


setDeleteAttributes

public void setDeleteAttributes(DeleteAttributesList value)
A key-value list with attributes that will be deleted from this contact.


getInsertAttributes

public AttributesList getInsertAttributes()
A key-value list with attributes that will be inserted into this contact.


setInsertAttributes

public void setInsertAttributes(AttributesList value)
A key-value list with attributes that will be inserted into this contact.


getUpdateAttributes

public AttributesList getUpdateAttributes()
A key-value list with attributes that will be update for this contact.


setUpdateAttributes

public void setUpdateAttributes(AttributesList value)
A key-value list with attributes that will be update for this contact.


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.