Platform SDK Java 8.5 API Reference

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

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

This request removes all attributes from a specified contact.

Required parameters:

Name Description
setContactId(java.lang.String) Unique ID of the Contact for which all attributes will be deleted.
setTenantId(java.lang.Integer) The unique tenant ID.

Related Events:
Name Description
EventRemoveAllAttributes Indicates that all attributes were successfully removed from a contact.
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
RequestRemoveAllAttributes()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestRemoveAllAttributes 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()
          Contact ID.
 java.util.List getCustomPackagers()
           
 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.
 int hashCode()
           
 void setContactId(java.lang.String value)
          Contact ID.
 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.
 
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

RequestRemoveAllAttributes

public RequestRemoveAllAttributes()
Method Detail

create

public static RequestRemoveAllAttributes create()

getContactId

public java.lang.String getContactId()
Contact ID.


setContactId

public void setContactId(java.lang.String value)
Contact 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. 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.


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.