Package com.day.cq.mcm.emailprovider.types

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 final String
    PERSONALIZATION_KEY
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMapping(String attributeName, String replacementText)
    This function adds a personalization mapping
    Map<String,String>
    getAllMappings()
    This function returns all attribute name and replacemenet text mappings.
    String
    getMapping(String attributeName)
    This function returns the mapping corresponding to an attribute
    String
    getPrefixPattern()
    This function returns the prefix to be used with replacement text.
    String
    getSuffixPattern()
    This function returns the suffix to be used with replacement text.
    void
    removeMapping(String attributeName)
    This function removes a personalization mapping
    void
    setPrefixPattern(String prefixPattern)
    This function sets the prefix to be used for the replacement text
    void
    setSuffixPattern(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 Details

  • Method Details

    • addMapping

      void addMapping(String attributeName, String replacementText)
      This function adds a personalization mapping
      Parameters:
      attributeName - name of the attribute
      replacementText - replacement string to be used

    • removeMapping

      void removeMapping(String attributeName)
      This function removes a personalization mapping
      Parameters:
      attributeName - name of the attribute that needs to be removed.

    • getMapping

      String getMapping(String attributeName)
      This function returns the mapping corresponding to an attribute
      Parameters:
      attributeName - attribute name
      Returns:
      attribute replacement text for the attribute

    • getAllMappings

      Map<String,String> getAllMappings()
      This function returns all attribute name and replacemenet text mappings.
      Returns:
      A map containing all the mappings.

    • getPrefixPattern

      String getPrefixPattern()
      This function returns the prefix to be used with replacement text.
      Returns:
      The prefix

    • setPrefixPattern

      void setPrefixPattern(String prefixPattern)
      This function sets the prefix to be used for the replacement text
      Parameters:
      prefixPattern - The prefix.

    • getSuffixPattern

      String getSuffixPattern()
      This function returns the suffix to be used with replacement text.
      Returns:
      The prefix

    • setSuffixPattern

      void setSuffixPattern(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.