Platform SDK Java 8.5 API Reference

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

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

This request is intended for obtaining the complete list of all Contact Attribute objects associated with this Contact. Contact Attribute objects must be declared in Configuration Server in the Contact Attribute enumerator (this configuration is Tenant specific). By default, the existing Contact Attributes are: AccountNumber, ContactId, CustomerSegment, EmailAddress, FirstName, LastName, PhoneNumber, PIN, and Title.

Required parameters:

Name Description
setContactId(java.lang.String) ID of the contact whose attributes you want returned.

Related Events:
Name Description
EventGetAttributes This event returns a complete list of contact attributes (as declared in the Contact Attribute enumerator in Configuration Server). By default, the existing Contact Attributes are: AccountNumber, ContactId, CustomerSegment, EmailAddress, FirstName, LastName, PhoneNumber, PIN, and Title.
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
RequestGetAttributes()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestGetAttributes create()
           
 com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
           
 boolean equals(java.lang.Object obj)
           
 StringList getAttributeList()
          A key-value list specifying which Contact attributes to return.
 java.util.Map getCompounds()
           
 java.lang.String getContactId()
          ID for the desired Contact.
 java.util.List getCustomPackagers()
           
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 int hashCode()
           
 void setAttributeList(StringList value)
          A key-value list specifying which Contact attributes to return.
 void setContactId(java.lang.String value)
          ID for the desired 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

RequestGetAttributes

public RequestGetAttributes()
Method Detail

create

public static RequestGetAttributes create()

getContactId

public java.lang.String getContactId()
ID for the desired Contact.


setContactId

public void setContactId(java.lang.String value)
ID for the desired Contact.


getAttributeList

public StringList getAttributeList()
A key-value list specifying which Contact attributes to return. If this parameter is not present or if the key-value list is empty, then all attributes are returned.


setAttributeList

public void setAttributeList(StringList value)
A key-value list specifying which Contact attributes to return. If this parameter is not present or if the key-value list is empty, then all attributes are returned.


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.