public interface TagEngine
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
Copyright.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
parse(java.lang.String inputString)
Parses the given input string looking for predefined tags and replacing them with
the value returned by getTagValue() method calls.
|
java.util.Map |
parseToGetTagNameValueMap(java.lang.String inputString)
Parses the given input string looking for the map of the predefined tags and
their values returned by getTagValue() method calls.
|
java.lang.String |
renderEmailContent(java.lang.String inputString)
This method is overloaded version of renderEmailContent(String, Hashtable).
|
java.lang.String |
renderEmailContent(java.lang.String inputString,
java.util.Hashtable parameters)
After setting the tagParmeters in class level variable, this method calls
the overloaded version renderEmailContent(inputString) function to
get the result.
|
void |
setCommandContext(com.ibm.commerce.command.CommandContext commandContext)
Sets the command Context
|
void |
setTagParameters(java.util.Hashtable tagParametersCopy)
Sets the tag parameters, which might be used while getting the replacement value for tag
|
void |
setTagParameters(java.lang.String name,
java.lang.String value)
Sets the key-value pair, used while parsing the tag.
|
static final java.lang.String COPYRIGHT
java.lang.String parse(java.lang.String inputString) throws com.ibm.commerce.exception.ECException
inputString
- - string to be parsedcom.ibm.commerce.exception.ECException
java.util.Map parseToGetTagNameValueMap(java.lang.String inputString) throws com.ibm.commerce.exception.ECException
inputString
- - string to be parsedcom.ibm.commerce.exception.ECException
java.lang.String renderEmailContent(java.lang.String inputString) throws com.ibm.commerce.exception.ECException
inputString
- - The string which needs to be parsed.com.ibm.commerce.exception.ECException
- - throws ECExceptionjava.lang.String renderEmailContent(java.lang.String inputString, java.util.Hashtable parameters) throws com.ibm.commerce.exception.ECException
inputString
- - The string which needs to be parsed.parameters
- - The hashtable containing key-value pairs used during parsing
of the given input string. User may also set values for recordOpen(0 or 1) and
contentFormat(HTML or Plain text) keys.
This method then adds the HTML snippet to record e-mail opened event
(if recordOpen = 1). If the content type is HTML.
(contentFormat = 1), then this method adds the
to the result string.-
- throws ECExceptioncom.ibm.commerce.exception.ECException
TagEngine.renderEmailContent(String inputString);
void setCommandContext(com.ibm.commerce.command.CommandContext commandContext)
commandContext
- void setTagParameters(java.util.Hashtable tagParametersCopy)
tagParametersCopy
- void setTagParameters(java.lang.String name, java.lang.String value)
name
- - keyvalue
- - tag parameter value