com.ibm.commerce.emarketing.emailtemplate.tag

Class TagEMSpotBase

  • java.lang.Object
    • com.ibm.commerce.emarketing.emailtemplate.tag.TagEMSpotBase
  • All Implemented Interfaces:
    Tag
    Direct Known Subclasses:
    TagEMSpot


    public abstract class TagEMSpotBase
    extends java.lang.Object
    implements Tag
    An abstract base class which retrieves the data for the email template EMSpot tag class
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      COPYRIGHT
    • Constructor Summary

      Constructors 
      Constructor and Description
      TagEMSpotBase()
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.command.CommandContext getCommandContext()
      Returns the CommandContext object
      java.lang.String getESpotViewDirectURL()
      Returns the JSP url which will be used to evaluate the emarketing spot content
      java.lang.String getJspPath()
      Returns the jsp path used by the email template engine to evaluate the emarketing spot content
      com.ibm.commerce.datatype.TypedProperty getProperties()
      Returns the properties that will be passed while invoking the espot jsp
      java.util.Hashtable getTagParameters()
      Returns the tag parameters for the email EMSpot tag
      void setCommandContext(com.ibm.commerce.command.CommandContext cc)
      Sets the command Context.
      void setProperties(com.ibm.commerce.datatype.TypedProperty prop)
      Sets the properties to be used while invoking the espot jsp
      void setTagParameters(java.util.Hashtable tagParametersCopy)
      Copies the hash table containing key-value parameter required to evaluate this tag,
      void setTagParameters(java.lang.String tagParamName, java.lang.String tagParamValue)
      Sets the key - value parameter, required to evaluate this tag.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.emarketing.emailtemplate.tag.Tag

        getTagValue
    • Constructor Detail

      • TagEMSpotBase

        public TagEMSpotBase()
        Constructor.
    • Method Detail

      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        Returns the CommandContext object
        Returns:
        The CommandContext object
      • getESpotViewDirectURL

        public java.lang.String getESpotViewDirectURL()
        Returns the JSP url which will be used to evaluate the emarketing spot content
        Returns:
        The JSP url
      • getJspPath

        public java.lang.String getJspPath()
        Returns the jsp path used by the email template engine to evaluate the emarketing spot content
        Returns:
        The JSP Path to the emarketingSpot JSP which will be used to evaluate the emarketing spot content
      • getProperties

        public com.ibm.commerce.datatype.TypedProperty getProperties()
        Returns the properties that will be passed while invoking the espot jsp
        Returns:
        The properties that will be passed while invoking the espot jsp
      • getTagParameters

        public java.util.Hashtable getTagParameters()
        Returns the tag parameters for the email EMSpot tag
        Returns:
        The tagParameters
      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext cc)
        Sets the command Context.
        Specified by:
        setCommandContext in interface Tag
        Parameters:
        cc - Command Context
      • setProperties

        public void setProperties(com.ibm.commerce.datatype.TypedProperty prop)
        Sets the properties to be used while invoking the espot jsp
        Parameters:
        prop -
      • setTagParameters

        public void setTagParameters(java.util.Hashtable tagParametersCopy)
        Copies the hash table containing key-value parameter required to evaluate this tag,
        Specified by:
        setTagParameters in interface Tag
        Parameters:
        tagParametersCopy - - Hashtable
      • setTagParameters

        public void setTagParameters(java.lang.String tagParamName,
                                     java.lang.String tagParamValue)
        Sets the key - value parameter, required to evaluate this tag.
        Specified by:
        setTagParameters in interface Tag
        Parameters:
        tagParamName - - parameter Name
        tagParamValue - - parameter Value
        See Also:
        com.ibm.commerce.emarketing.emailtemplate.tag.Tag#setTagParameters()