|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
com.genesyslab.platform.contacts.protocol.contactserver.requests.RequestRenderFieldCodes
public final class RequestRenderFieldCodes
This request takes a block of template text, and replaces generic
field codes with the actual values specified.
Required parameters:
Name | Description |
---|---|
setText(java.lang.String) |
The template text that will be rendered. |
Name | Description |
---|---|
EventRenderFieldCodes |
This event returns the adjusted block of text, after a block of template text is rendered to replace field codes with actual values. |
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 | |
---|---|
RequestRenderFieldCodes()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static RequestRenderFieldCodes |
create()
|
com.genesyslab.platform.commons.protocol.runtime.DataSupport |
createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
|
boolean |
equals(java.lang.Object obj)
|
AgentProperties |
getAgent()
Agent details used to replace field codes in the template text. |
java.util.Map |
getCompounds()
|
ContactProperties |
getContact()
Contact details used to replace field codes in the template text. |
java.util.List |
getCustomPackagers()
|
CustomProperties |
getCustomProperties()
Custom properties used to replace field codes in the template text. |
ContactInteractionProperties |
getInteraction()
Interaction details used to replace field codes in the template text. |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
java.lang.String |
getText()
The template text that will be rendered. |
int |
hashCode()
|
void |
setAgent(AgentProperties value)
Agent details used to replace field codes in the template text. |
void |
setContact(ContactProperties value)
Contact details used to replace field codes in the template text. |
void |
setCustomProperties(CustomProperties value)
Custom properties used to replace field codes in the template text. |
void |
setInteraction(ContactInteractionProperties value)
Interaction details used to replace field codes in the template text. |
void |
setText(java.lang.String value)
The template text that will be rendered. |
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 |
---|
public static final int ID
public static final java.lang.String NAME
Constructor Detail |
---|
public RequestRenderFieldCodes()
Method Detail |
---|
public static RequestRenderFieldCodes create()
public java.lang.String getText()
public void setText(java.lang.String value)
public ContactInteractionProperties getInteraction()
public void setInteraction(ContactInteractionProperties value)
public ContactProperties getContact()
public void setContact(ContactProperties value)
public AgentProperties getAgent()
public void setAgent(AgentProperties value)
public CustomProperties getCustomProperties()
public void setCustomProperties(CustomProperties value)
public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |