Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.espemail
Class AbstractMessage

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.webmedia.protocol.espemail.AbstractMessage
All Implemented Interfaces:
EndpointSupport, ProtocolDescriptionSupport, Referenceable, com.genesyslab.platform.commons.protocol.runtime.DataSupport, com.genesyslab.platform.commons.protocol.runtime.UpdatableProtocolId, RequestorInfoSupport, EspEmailMessage
Direct Known Subclasses:
EventCreateWebEmailIn, EventError, RequestCreateWebEmailIn

public abstract class AbstractMessage
extends Message
implements ProtocolDescriptionSupport, com.genesyslab.platform.commons.protocol.runtime.UpdatableProtocolId, Referenceable, com.genesyslab.platform.commons.protocol.runtime.DataSupport, EndpointSupport, EspEmailMessage, RequestorInfoSupport


Field Summary
protected  int protId
           
protected static java.lang.String REF_ID_KEY
           
 
Constructor Summary
protected AbstractMessage(int id, java.lang.String name, ProtocolDescription description)
           
 
Method Summary
 java.util.Map attributes()
           
 boolean equals(java.lang.Object obj)
           
 java.util.Map getCompounds()
           
 java.util.List getCustomPackagers()
           
 Endpoint getEndpoint()
          Indicates server URI from which current message has been received.
 java.lang.String getEnumDescription(java.lang.Class enumType, int val)
           
 com.genesyslab.platform.commons.protocol.runtime.CodecLazyParser getLazyParser()
           
 java.lang.Object getMessageAttribute(java.lang.String index)
          Returns message attribute as object by specified index.
 int getProtocolId()
          Returns hash code of protocol object which handled the message.
 java.lang.Integer getReferenceId()
           
 RequestorInfo getRequestorInfo()
          Returns requestor information
 int hashCode()
           
 java.lang.Object retreiveReference()
           
 void setEndpoint(Endpoint endpoint)
           
 void setProtocolId(int prot_id)
           
 void setReferenceId(java.lang.Integer value)
           
 void setRequestorInfo(RequestorInfo requestorInfo)
          Sets requestor information
 java.lang.String toString()
           
 java.lang.String toString(boolean hide, boolean truncate)
           
protected  java.lang.String toString(int indent, boolean hide, boolean truncate)
           
 void updateReference(java.lang.Object reference)
           
 
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
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
createClone, getMetaData
 

Field Detail

protId

protected int protId

REF_ID_KEY

protected static final java.lang.String REF_ID_KEY
See Also:
Constant Field Values
Constructor Detail

AbstractMessage

protected AbstractMessage(int id,
                          java.lang.String name,
                          ProtocolDescription description)
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class DataObject

toString

public java.lang.String toString(boolean hide,
                                 boolean truncate)
Specified by:
toString in class DataObject

toString

protected java.lang.String toString(int indent,
                                    boolean hide,
                                    boolean truncate)

setEndpoint

public void setEndpoint(Endpoint endpoint)
Specified by:
setEndpoint in interface EndpointSupport

getEndpoint

public Endpoint getEndpoint()
Description copied from class: Message
Indicates server URI from which current message has been received.

Specified by:
getEndpoint in interface EndpointSupport
Specified by:
getEndpoint in class Message
Returns:
Endpoint

getProtocolId

public int getProtocolId()
Description copied from class: Message
Returns hash code of protocol object which handled the message. When the message is not received from protocol the value of this property is zero.

Specified by:
getProtocolId in class Message
Returns:
protocol hash code or zero.

setProtocolId

public void setProtocolId(int prot_id)
Specified by:
setProtocolId in interface com.genesyslab.platform.commons.protocol.runtime.UpdatableProtocolId

attributes

public java.util.Map attributes()
Specified by:
attributes in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport

retreiveReference

public java.lang.Object retreiveReference()
Specified by:
retreiveReference in interface Referenceable

updateReference

public void updateReference(java.lang.Object reference)
Specified by:
updateReference in interface Referenceable

getReferenceId

public java.lang.Integer getReferenceId()

setReferenceId

public void setReferenceId(java.lang.Integer value)

getRequestorInfo

public RequestorInfo getRequestorInfo()
Returns requestor information

Specified by:
getRequestorInfo in interface RequestorInfoSupport

setRequestorInfo

public void setRequestorInfo(RequestorInfo requestorInfo)
Sets requestor information

Specified by:
setRequestorInfo in interface RequestorInfoSupport
Parameters:
requestorInfo - new value of the property

getLazyParser

public com.genesyslab.platform.commons.protocol.runtime.CodecLazyParser getLazyParser()
Specified by:
getLazyParser in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport

getMessageAttribute

public java.lang.Object getMessageAttribute(java.lang.String index)
Description copied from class: Message
Returns message attribute as object by specified index. Returns null if no such attribute in the message.

Specified by:
getMessageAttribute in class Message
Parameters:
index - index of attribute
Returns:
attribute or null

getCompounds

public java.util.Map getCompounds()
Specified by:
getCompounds in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport

getCustomPackagers

public java.util.List getCustomPackagers()
Specified by:
getCustomPackagers in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport

getEnumDescription

public java.lang.String getEnumDescription(java.lang.Class enumType,
                                           int val)

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.