com.ibm.commerce.marketing.runtime.util

Class ActivityTrigger

  • java.lang.Object
    • com.ibm.commerce.marketing.runtime.util.ActivityTrigger


  • public class ActivityTrigger
    extends java.lang.Object
    This class encapsulates all the parameters that compose a trigger that is sent to the marketing engine. It is not expected that a customization would need to use this class.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CLASSNAME
      The name of this class.
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
    • Constructor Summary

      Constructors 
      Constructor and Description
      ActivityTrigger(ActionExpression actionExpression, java.lang.String newName, java.util.Map newNameValuePairs)
      The constructor creates all the parameters that compose a trigger that is sent to the marketing engine.
      ActivityTrigger(java.lang.Integer newStoreId, java.lang.String newName, java.util.Map newNameValuePairs)
      The constructor creates all the parameters that compose a trigger that is sent to the marketing engine.
      ActivityTrigger(java.lang.String newPersonalizationId, java.util.Map newTriggerParameters, java.lang.Integer newStoreId, java.lang.String newName, java.util.Map newNameValuePairs)
      The constructor creates all the parameters that compose a trigger that is sent to the marketing engine.
      ActivityTrigger(java.lang.String newPersonalizationId, java.lang.String newTriggerParameters, java.lang.Integer newStoreId, java.lang.String newName, java.util.Map newNameValuePairs)
      The constructor creates all the parameters that compose a trigger that is sent to the marketing engine.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getName()
      This method returns the name associated with the trigger.
      java.util.Map getNameValuePairs()
      This method returns the name value pairs associated with the trigger.
      java.lang.String getPersonalizationId()
      This method returns the personalization ID associated with the trigger.
      java.lang.Integer getStoreId()
      This method returns the store ID associated with the trigger.
      java.lang.String getTriggerParameters()
      This method returns the trigger parameters associated with the trigger.
      java.util.Map getTriggerParametersMap()
      This method returns the trigger parameters associated with the trigger.
      void setName(java.lang.String newName)
      This method sets the trigger name associated with the trigger.
      void setNameValuePairs(java.util.Map newNameValuePairs)
      This method sets the name value pairs associated with the trigger.
      void setPersonalizationId(java.lang.String newPersonalizationId)
      This method sets the personalization ID associated with the trigger.
      void setStoreId(java.lang.Integer newStoreId)
      This method sets the store ID associated with the trigger.
      void setTriggerParameters(java.util.Map newTriggerParameters)
      This method sets the trigger parameters associated with the trigger.
      void setTriggerParameters(java.lang.String newTriggerParameters)
      This method sets the trigger parameters associated with the trigger.
      java.lang.String toString()
      This method returns a string with the content of the activity trigger.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • CLASSNAME

        public static final java.lang.String CLASSNAME
        The name of this class.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ActivityTrigger

        public ActivityTrigger(java.lang.Integer newStoreId,
                               java.lang.String newName,
                               java.util.Map newNameValuePairs)
        The constructor creates all the parameters that compose a trigger that is sent to the marketing engine. This constructor is no longer used.
        Parameters:
        newStoreId - The current store ID.
        newName - The trigger name to send.
        newNameValuePairs - The name value pairs to send with the trigger.
      • ActivityTrigger

        public ActivityTrigger(java.lang.String newPersonalizationId,
                               java.lang.String newTriggerParameters,
                               java.lang.Integer newStoreId,
                               java.lang.String newName,
                               java.util.Map newNameValuePairs)
        The constructor creates all the parameters that compose a trigger that is sent to the marketing engine. This constructor is no longer used.
        Parameters:
        newPersonalizationId - The user's personalization ID.
        newTriggerParameters - The user's trigger parameters. Use MarketingUtil.createTriggerParametersString to generate this parameter. The parameters in the string will be decoded.
        newStoreId - The current store ID.
        newName - The trigger name to send.
        newNameValuePairs - The name value pairs to send with the trigger.
      • ActivityTrigger

        public ActivityTrigger(java.lang.String newPersonalizationId,
                               java.util.Map newTriggerParameters,
                               java.lang.Integer newStoreId,
                               java.lang.String newName,
                               java.util.Map newNameValuePairs)
        The constructor creates all the parameters that compose a trigger that is sent to the marketing engine. It is called by the Get MarketingSpotData service to pass the necessary information to the marketing engine.
        Parameters:
        newPersonalizationId - The user's personalization ID.
        newTriggerParameters - The user's trigger parameters.
        newStoreId - The current store ID.
        newName - The trigger name to send.
        newNameValuePairs - The name value pairs to send with the trigger.
      • ActivityTrigger

        public ActivityTrigger(ActionExpression actionExpression,
                               java.lang.String newName,
                               java.util.Map newNameValuePairs)
        The constructor creates all the parameters that compose a trigger that is sent to the marketing engine. It is called by the Process Activity and Process MarketingTrigger services to pass the necessary information to the marketing engine.
        Parameters:
        actionExpression - The service action expression. The trigger parameters are found in the extended parameters of the action expression.
        newName - The trigger name to send.
        newNameValuePairs - The name value pairs to send with the trigger.
    • Method Detail

      • getPersonalizationId

        public java.lang.String getPersonalizationId()
        This method returns the personalization ID associated with the trigger.
        Returns:
        Returns the personalization ID.
      • setPersonalizationId

        public void setPersonalizationId(java.lang.String newPersonalizationId)
        This method sets the personalization ID associated with the trigger.
        Parameters:
        newPersonalizationId - The personalization ID to set.
      • getName

        public java.lang.String getName()
        This method returns the name associated with the trigger.
        Returns:
        Returns the trigger name.
      • setName

        public void setName(java.lang.String newName)
        This method sets the trigger name associated with the trigger.
        Parameters:
        newName - The trigger name to set.
      • getNameValuePairs

        public java.util.Map getNameValuePairs()
        This method returns the name value pairs associated with the trigger.
        Returns:
        Returns the name value pairs.
      • setNameValuePairs

        public void setNameValuePairs(java.util.Map newNameValuePairs)
        This method sets the name value pairs associated with the trigger.
        Parameters:
        newNameValuePairs - The name value pairs to set.
      • getStoreId

        public java.lang.Integer getStoreId()
        This method returns the store ID associated with the trigger.
        Returns:
        Returns the store ID.
      • setStoreId

        public void setStoreId(java.lang.Integer newStoreId)
        This method sets the store ID associated with the trigger.
        Parameters:
        newStoreId - The store ID to set.
      • getTriggerParameters

        public java.lang.String getTriggerParameters()
        This method returns the trigger parameters associated with the trigger. It is preferable to use the Map representation of the trigger parameters than the String representation.
        Returns:
        Returns the trigger parameters string.
      • getTriggerParametersMap

        public java.util.Map getTriggerParametersMap()
        This method returns the trigger parameters associated with the trigger. It is preferable to use the Map representation of the trigger parameters than the String representation.
        Returns:
        Returns the trigger parameters string.
      • setTriggerParameters

        public void setTriggerParameters(java.lang.String newTriggerParameters)
        This method sets the trigger parameters associated with the trigger. It is preferable to use the Map representation of the trigger parameters than the String representation.
        Parameters:
        newTriggerParameters - The trigger parameters to set.
      • setTriggerParameters

        public void setTriggerParameters(java.util.Map newTriggerParameters)
        This method sets the trigger parameters associated with the trigger. It is preferable to use the Map representation of the trigger parameters than the String representation.
        Parameters:
        newTriggerParameters - The trigger parameters to set.
      • toString

        public java.lang.String toString()
        This method returns a string with the content of the activity trigger.
        Overrides:
        toString in class java.lang.Object
        Returns:
        This method returns a string with the content of the activity trigger.