com.ibm.commerce.emarketing.beans

Class EmailActivityUrlHelperDataBean

  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, com.ibm.commerce.security.Delegator, com.ibm.commerce.security.Protectable, java.io.Serializable

    public class EmailActivityUrlHelperDataBean
extends EmailActivityUrlHelperDataBeanBase
    Provides JSP authors with the encrypted URL strings to use to record various e-mail activity events.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      Copyright.
      static java.lang.String ENCRYPTO
      The query string parameter used to identify the encrypted parameters.

      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getClickedEventUrl()
      Get the clickedEventUrl.
      java.lang.String getClickedEventUrl(java.lang.String nextUrl)
      Get the clickedEventUrl.
      java.lang.String getOpenedEventUrl()
      Get the OpenedEventUrl.
      java.lang.String getOpenedEventUrl(java.lang.String nextUrl)
      Get the OpenedEventUrl.
      java.lang.String getOptOutUrl()
      Get the optOutUrl.
      java.lang.String getOptOutUrl(java.lang.String nextUrl)
      Get the optOutUrl.
      void populate()
      Populate the data bean.
      void setClickForwardUrl(java.lang.String clickUrl)
      Set the click forward URL.
      void setEmailPromotionId(java.lang.Integer emailPromotionId)
      Set the e-mail promotion ID.
      void setOptOutForwardUrl(java.lang.String optOutUrl)
      Set the opt out forward URL.
      void setStoreId(java.lang.Integer storeId)
      Set the store ID.
      void setUrlHeader(java.lang.String urlHeader)
      Set the url header.
      void setUserId(java.lang.Long userId)
      Set the user ID.

      • Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

        fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

      • Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

        getRequestProperties, setRequestProperties

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills

      • Methods inherited from interface com.ibm.commerce.beans.InputDataBean

        getRequestProperties, setRequestProperties

    • Field Detail

      • ENCRYPTO

        public static final java.lang.String ENCRYPTO
        The query string parameter used to identify the encrypted parameters.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EmailActivityUrlHelperDataBean

        public EmailActivityUrlHelperDataBean()
        Constructor

      • EmailActivityUrlHelperDataBean

        public EmailActivityUrlHelperDataBean(java.lang.String urlHeader,
                                      java.lang.Long usersId,
                                      java.lang.Integer emailPromotionId,
                                      java.lang.Integer storeId)
        Constructor.
        Parameters:
        urlHeader - The URL path to the EmailEventCmdImpl command.
        usersId - The ID of the user who received the email.
        emailPromotionId - The ID of the e-mail activity.
        storeId - The ID of the store to which the activity belongs.

    • Method Detail

      • getClickedEventUrl

        public java.lang.String getClickedEventUrl()
        Get the clickedEventUrl.
        Returns:
        clickedEventUrl.

      • getClickedEventUrl

        public java.lang.String getClickedEventUrl(java.lang.String nextUrl)
        Get the clickedEventUrl.
        Parameters:
        nextUrl - The URL to forward on to the browser after recording the click event.
        Returns:
        clickedEventUrl.

      • getOpenedEventUrl

        public java.lang.String getOpenedEventUrl()
        Get the OpenedEventUrl.
        Returns:
        OpenedEventUrl.

      • getOpenedEventUrl

        public java.lang.String getOpenedEventUrl(java.lang.String nextUrl)
        Get the OpenedEventUrl.
        Parameters:
        nextUrl - The URL to forward on to the browser after recording the open event.
        Returns:
        OpenedEventUrl.

      • getOptOutUrl

        public java.lang.String getOptOutUrl()
        Get the optOutUrl.
        Returns:
        optOutUrl.

      • getOptOutUrl

        public java.lang.String getOptOutUrl(java.lang.String nextUrl)
        Get the optOutUrl.
        Parameters:
        nextUrl - The URL to forward on to the browser after recording the opt out event.
        Returns:
        optOutUrl.

      • populate

        public void populate()
              throws java.lang.Exception
        Populate the data bean.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        Throws:
        java.lang.Exception - Thrown when the encryption algorithms fail to execute successfully.

      • setClickForwardUrl

        public void setClickForwardUrl(java.lang.String clickUrl)
        Set the click forward URL.
        Parameters:
        clickUrl - The URL to forward on to the browser after recording the click event.

      • setEmailPromotionId

        public void setEmailPromotionId(java.lang.Integer emailPromotionId)
        Set the e-mail promotion ID.
        Parameters:
        emailPromotionId - The ID of the e-mail activity.

      • setOptOutForwardUrl

        public void setOptOutForwardUrl(java.lang.String optOutUrl)
        Set the opt out forward URL.
        Parameters:
        optOutUrl - The URL to forward on to the browser after recording the opt out event.

      • setStoreId

        public void setStoreId(java.lang.Integer storeId)
        Set the store ID.
        Parameters:
        storeId - The ID of the store to which the activity belongs.

      • setUrlHeader

        public void setUrlHeader(java.lang.String urlHeader)
        Set the url header.
        Parameters:
        urlHeader - The URL path to the EmailEventCmdImpl command.

      • setUserId

        public void setUserId(java.lang.Long userId)
        Set the user ID.
        Parameters:
        userId - The ID of the user who received the email.
Skip navigation links