Platform SDK Java 8.5 API Reference

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

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

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.

Related Events:
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

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

RequestRenderFieldCodes

public RequestRenderFieldCodes()
Method Detail

create

public static RequestRenderFieldCodes create()

getText

public java.lang.String getText()
The template text that will be rendered.


setText

public void setText(java.lang.String value)
The template text that will be rendered.


getInteraction

public ContactInteractionProperties getInteraction()
Interaction details used to replace field codes in the template text.


setInteraction

public void setInteraction(ContactInteractionProperties value)
Interaction details used to replace field codes in the template text.


getContact

public ContactProperties getContact()
Contact details used to replace field codes in the template text.


setContact

public void setContact(ContactProperties value)
Contact details used to replace field codes in the template text.


getAgent

public AgentProperties getAgent()
Agent details used to replace field codes in the template text.


setAgent

public void setAgent(AgentProperties value)
Agent details used to replace field codes in the template text.


getCustomProperties

public CustomProperties getCustomProperties()
Custom properties used to replace field codes in the template text.


setCustomProperties

public void setCustomProperties(CustomProperties value)
Custom properties used to replace field codes in the template text.


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.