Interface PersonalizationInfo
-
public interface PersonalizationInfo
Defines interface for all the Personalization mappings for an email provider.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PERSONALIZATION_KEY
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addMapping(java.lang.String attributeName, java.lang.String replacementText)
This function adds a personalization mappingjava.util.Map<java.lang.String,java.lang.String>
getAllMappings()
This function returns all attribute name and replacemenet text mappings.java.lang.String
getMapping(java.lang.String attributeName)
This function returns the mapping corresponding to an attributejava.lang.String
getPrefixPattern()
This function returns the prefix to be used with replacement text.java.lang.String
getSuffixPattern()
This function returns the suffix to be used with replacement text.void
removeMapping(java.lang.String attributeName)
This function removes a personalization mappingvoid
setPrefixPattern(java.lang.String prefixPattern)
This function sets the prefix to be used for the replacement textvoid
setSuffixPattern(java.lang.String suffixPattern)
This function sets the suffix to be used with replacement text.boolean
usePrefix()
This function tells whether prefix has to be added to replacement text or not.boolean
useSuffix()
This function tells whether suffix has to be added to replacement text or not.
-
-
-
Field Detail
-
PERSONALIZATION_KEY
static final java.lang.String PERSONALIZATION_KEY
- See Also:
- Constant Field Values
-
-
Method Detail
-
addMapping
void addMapping(java.lang.String attributeName, java.lang.String replacementText)
This function adds a personalization mapping- Parameters:
attributeName
- name of the attributereplacementText
- replacement string to be used
-
removeMapping
void removeMapping(java.lang.String attributeName)
This function removes a personalization mapping- Parameters:
attributeName
- name of the attribute that needs to be removed.
-
getMapping
java.lang.String getMapping(java.lang.String attributeName)
This function returns the mapping corresponding to an attribute- Parameters:
attributeName
- attribute name- Returns:
- attribute replacement text for the attribute
-
getAllMappings
java.util.Map<java.lang.String,java.lang.String> getAllMappings()
This function returns all attribute name and replacemenet text mappings.- Returns:
- A map containing all the mappings.
-
getPrefixPattern
java.lang.String getPrefixPattern()
This function returns the prefix to be used with replacement text.- Returns:
- The prefix
-
setPrefixPattern
void setPrefixPattern(java.lang.String prefixPattern)
This function sets the prefix to be used for the replacement text- Parameters:
prefixPattern
- The prefix.
-
getSuffixPattern
java.lang.String getSuffixPattern()
This function returns the suffix to be used with replacement text.- Returns:
- The prefix
-
setSuffixPattern
void setSuffixPattern(java.lang.String suffixPattern)
This function sets the suffix to be used with replacement text.- Parameters:
suffixPattern
-
-
usePrefix
boolean usePrefix()
This function tells whether prefix has to be added to replacement text or not.- Returns:
- true if prefix has to be added and false otherwise.
-
useSuffix
boolean useSuffix()
This function tells whether suffix has to be added to replacement text or not.- Returns:
- true if suffix has to be added and false otherwise.
-
-