Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver
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.contacts.protocol.contactserver.AbstractMessage
All Implemented Interfaces:
EndpointSupport, ProtocolDescriptionSupport, Referenceable, com.genesyslab.platform.commons.protocol.runtime.DataSupport, com.genesyslab.platform.commons.protocol.runtime.UpdatableProtocolId, ContactServerMessage, Printable, RequestorInfoSupport
Direct Known Subclasses:
EventAddAgentStdRespFavorite, EventAddCategory, EventAddCategoryAttribute, EventAddCategoryRoot, EventAddDocument, EventAddFieldCode, EventAddFieldValue, EventAddModel, EventAddScreeningRule, EventAddStandardResponse, EventAddStdRespUsage, EventAddTrainingDataObject, EventAssignInteractionToContact, EventBoostDocument, EventCheckForUpdates, EventContactListGet, EventContactListGetNextPage, EventContactListRelease, EventCountInteractions, EventCreateStandardResponseRevision, EventDelete, EventDeleteAgentStdRespFavorite, EventDeleteCategory, EventDeleteCategoryAttribute, EventDeleteCategoryRoot, EventDeleteFieldCode, EventDeleteFieldValue, EventDeleteInteraction, EventDeleteModel, EventDeleteProperties, EventDeleteScreeningRule, EventDeleteStandardResponse, EventDeleteTrainingDataObject, EventError, EventFindOrCreatePhoneCall, EventGetAgentStdRespFavorites, EventGetAllCategories, EventGetAttributes, EventGetCategory, EventGetCategoryAttribute, EventGetCategoryAttributes, EventGetContacts, EventGetDocument, EventGetFieldCode, EventGetFieldCodes, EventGetFieldValue, EventGetFieldValues, EventGetIndexProperties, EventGetInteractionContent, EventGetInteractionsForContact, EventGetInteractionsWithStatus, EventGetMergeDetail, EventGetModel, EventGetModels, EventGetProperties, EventGetRootCategories, EventGetScreeningRule, EventGetScreeningRules, EventGetServerTime, EventGetStandardResponse, EventGetStandardResponses, EventGetSystemSettings, EventGetTrainingDataObject, EventGetTrainingDataObjects, EventGetVersion, EventIdentifyContact, EventInsert, EventInsertInteraction, EventInteractionListGet, EventInteractionListGetNextPage, EventInteractionListRelease, EventMergeContacts, EventMergeListGet, EventMergeListGetNextPage, EventMergeListRelease, EventMoveCategory, EventRefresh, EventRemoveAllAttributes, EventRemoveDocument, EventRenderFieldCodes, EventRestoreStandardResponseRevision, EventSearch, EventSetInteractionStatus, EventSetProperties, EventStopInteraction, EventUnMergeContacts, EventUpdateAttributes, EventUpdateCategory, EventUpdateCategoryAttribute, EventUpdateDocument, EventUpdateFieldCode, EventUpdateFieldValue, EventUpdateInteraction, EventUpdateModel, EventUpdateScreeningRule, EventUpdateStandardResponse, EventUpdateTrainingDataObject, EventValidateFieldCodes, RequestAddAgentStdRespFavorite, RequestAddCategory, RequestAddCategoryAttribute, RequestAddCategoryRoot, RequestAddDocument, RequestAddFieldCode, RequestAddFieldValue, RequestAddModel, RequestAddScreeningRule, RequestAddStandardResponse, RequestAddStdRespUsage, RequestAddTrainingDataObject, RequestAssignInteractionToContact, RequestBoostDocument, RequestCheckForUpdates, RequestContactListGet, RequestContactListGetNextPage, RequestContactListRelease, RequestCountInteractions, RequestCreateStandardResponseRevision, RequestDelete, RequestDeleteAgentStdRespFavorite, RequestDeleteCategory, RequestDeleteCategoryAttribute, RequestDeleteCategoryRoot, RequestDeleteFieldCode, RequestDeleteFieldValue, RequestDeleteInteraction, RequestDeleteModel, RequestDeleteProperties, RequestDeleteScreeningRule, RequestDeleteStandardResponse, RequestDeleteTrainingDataObject, RequestFindOrCreatePhoneCall, RequestGetAgentStdRespFavorites, RequestGetAllCategories, RequestGetAttributes, RequestGetCategory, RequestGetCategoryAttribute, RequestGetCategoryAttributes, RequestGetContacts, RequestGetDocument, RequestGetFieldCode, RequestGetFieldCodes, RequestGetFieldValue, RequestGetFieldValues, RequestGetIndexProperties, RequestGetInteractionContent, RequestGetInteractionsForContact, RequestGetInteractionsWithStatus, RequestGetMergeDetail, RequestGetModel, RequestGetModels, RequestGetProperties, RequestGetRootCategories, RequestGetScreeningRule, RequestGetScreeningRules, RequestGetServerTime, RequestGetStandardResponse, RequestGetStandardResponses, RequestGetSystemSettings, RequestGetTrainingDataObject, RequestGetTrainingDataObjects, RequestGetVersion, RequestIdentifyContact, RequestInsert, RequestInsertInteraction, RequestInteractionListGet, RequestInteractionListGetNextPage, RequestInteractionListRelease, RequestMergeContacts, RequestMergeListGet, RequestMergeListGetNextPage, RequestMergeListRelease, RequestMoveCategory, RequestRefresh, RequestRemoveAllAttributes, RequestRemoveDocument, RequestRenderFieldCodes, RequestRestoreStandardResponseRevision, RequestSearch, RequestSetInteractionStatus, RequestSetProperties, RequestStopInteraction, RequestUnMergeContacts, RequestUpdateAttributes, RequestUpdateCategory, RequestUpdateCategoryAttribute, RequestUpdateDocument, RequestUpdateFieldCode, RequestUpdateFieldValue, RequestUpdateInteraction, RequestUpdateModel, RequestUpdateScreeningRule, RequestUpdateStandardResponse, RequestUpdateTrainingDataObject, RequestValidateFieldCodes

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


Field Summary
protected static java.lang.String REF_ID_KEY
           
 
Constructor Summary
protected AbstractMessage(int id, java.lang.String name)
           
protected AbstractMessage(int id, java.lang.String name, ProtocolDescription description)
           
 
Method Summary
 java.util.List getCustomPackagers()
           
 Endpoint getEndpoint()
          Indicates server URI from which current message has been received.
 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()
          Reference identifier of the request.
 RequestorInfo getRequestorInfo()
          Returns requestor information
 java.lang.Object retreiveReference()
           
 void setEndpoint(Endpoint endpoint)
           
 void setProtocolId(int protocolId)
           
 void setReferenceId(int referenceId)
          Reference identifier of the request.
 void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
 void setRequestorInfo(RequestorInfo requestorInfo)
          Sets requestor information
 java.lang.String toString()
           
 java.lang.String toString(boolean hide, boolean truncate)
           
 java.lang.String toString(int ident)
           
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 com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode
 
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
attributes, createClone, getCompounds, getMetaData
 

Field Detail

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)

AbstractMessage

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

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

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.

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

setEndpoint

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

setProtocolId

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

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()
Reference identifier of the request. It is client responsibility to generate the reference identifier and then tie the server response to the request.

Returns:
referenceId value of the protocol message

setReferenceId

public void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is client responsibility to generate the reference identifier and then tie the server response to the request.

Parameters:
referenceId - new value of the property

setReferenceId

public void setReferenceId(int referenceId)
Reference identifier of the request. It is client responsibility to generate the reference identifier and then tie the server response to the request.

Parameters:
referenceId - new value of the property

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

getCustomPackagers

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

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)

toString

public java.lang.String toString(int ident)
Specified by:
toString in interface Printable

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.