public class TriggerHandler
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String | ALL_USERS_TRUE
A constant representing that a trigger handler is for all users.
|
static java.lang.String | COPYRIGHT
IBM copyright notice field.
|
static java.lang.String | MARKETING_SPOT_BEHAVIOR
Constant to specify an e-Marketing Spot behavior.
|
static java.lang.String | MARKETING_SPOT_BEHAVIOR_DYNAMIC
Constant to specify an e-Marketing Spot is dynamic - different results can be displayed.
|
static java.lang.String | MARKETING_SPOT_BEHAVIOR_DYNAMIC_WITH_REFRESH
Constant to specify an e-Marketing Spot is dynamic and facet refresh is required.
|
static int | MARKETING_SPOT_BEHAVIOR_NO_TIME_LIMIT
Constant to specify the e-Marketing Spot has no specific time limit.
|
static java.lang.String | MARKETING_SPOT_BEHAVIOR_STATIC
Constant to specify an e-Marketing Spot is static - same results to all customers.
|
static java.lang.String | MARKETING_SPOT_BEHAVIOR_TIME_LIMIT
Constant to specify the time limit when the e-Marketing Spot behavior may change.
|
static java.lang.String | RETURN_MARKETING_SPOT_BEHAVIOR_TIME_LIMIT
Constant to specify the service should return the time limit when the e-Marketing Spot behavior may change.
|
static java.lang.String | TRIGGER_ACTIVITYACTION
Trigger name for ActivityAction.
|
static java.lang.String | TRIGGER_DISPLAYEMS
Trigger name for DisplayEms.
|
static java.lang.String | TRIGGER_DISPLAYEMS_PARAMETER_EMS_ID
emsId parameter for DisplayEms.
|
static java.lang.String | TRIGGER_TIMER
Trigger name for Timer.
|
static java.lang.String | XML_ATTRIBUTE_ACTION
The action to perform.
|
static java.lang.String | XML_ATTRIBUTE_NAME_ACTIVITY_ID
The activity ID.
|
Constructor and Description |
---|
TriggerHandler()
This is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected com.ibm.commerce.marketing.internal.runtime.objects.TriggerListen[] | findListeningActivity(ActivityTrigger activityTrigger)
This method finds all the activities which should be sent this trigger.
|
protected com.ibm.commerce.marketing.internal.runtime.objects.TriggerListen[] | findListeningActivity(ActivityTrigger activityTrigger, java.util.List previewReport)
This method finds all the activities which should be sent this trigger.
|
protected com.ibm.commerce.marketing.internal.runtime.objects.TriggerListen[] | findListeningActivity(ActivityTrigger activityTrigger, java.util.List previewReport, java.util.Map temporarySharedData)
This method finds all the activities which should be sent this trigger.
|
void | forwardTriggers(java.util.Map triggerParameters, java.lang.String personalizationId, java.lang.Integer storeId, java.util.Map nvpsForSend, java.util.Map nvpsForRecord)
This method will record user behaviors and forward triggers to the trigger handler.
|
void | forwardTriggers(java.lang.String triggerParameters, java.lang.String personalizationId, java.lang.Integer storeId, java.util.Map nvpsForSend, java.util.Map nvpsForRecord)
This method will record user behaviors and forward triggers to the trigger handler.
|
java.util.Map | getAndResetEmsClicksCounter()
This method returns the current accumulated statistics for the clicks of EMarketingSpots within an activity flow.
|
java.util.Map | getAndResetEmsViewsCounter()
This method returns the current accumulated statistics for the views of EMarketingSpots within an activity flow.
|
java.util.Map | getAndResetTestElementClicksCounter()
This method returns the current accumulated statistics for the clicks a test element within an activity experiment.
|
java.util.Map | getAndResetTestElementViewsCounter()
This method returns the current accumulated statistics for views of a test element within an activity experiment.
|
static java.lang.String | getBehaviorSetting(java.lang.String newBehavior, java.lang.String currentBehavior)
This method returns the appropriate setting for the e-Marketing Spot behavior based on the existing determined value, and the new determined value.
|
java.lang.String | getEMSBehavior(ActivityTrigger activityTrigger, java.lang.StringBuffer timeLimit)
This method gets the caching behavior for an e-Marketing Spot.
|
protected void | incrementClickStatistics(java.lang.Integer activityId, java.lang.Integer emsId, java.lang.Integer storeId)
This method increments by one the click statistics for an EMarketingSpot within an activity.
|
protected void | incrementTestElementClickStatistics(java.lang.Integer experimentId, java.lang.Integer testElementId, java.lang.Integer storeId)
This method increments by one the click statistics for a test element within an activity experiment.
|
void | incrementTestElementViewStatistics(java.lang.Integer experimentId, java.lang.Integer testElementId, java.lang.Integer storeId)
This method increments by one the view statistics for a test element within an activity experiment.
|
void | incrementViewStatistics(java.lang.Integer activityId, java.lang.Integer emsId, java.lang.Integer storeId)
This method increments by one the view statistics for an EMarketingSpot within an activity.
|
void | initialize()
This method initializes the shared TriggerHandler object.
|
static boolean | isActivityActive(Activity activity)
This method returns true if the current activity is active.
|
static boolean | isActivityActive(java.lang.Integer activityId)
This method returns true if the current activity is active.
|
static boolean | isActivityEndDateAfter(Activity activity, java.sql.Timestamp date)
This method returns true if the activity end date is after the given date.
|
static boolean | isActivityEndDateAfter(java.lang.Integer activityId, java.sql.Timestamp date)
This method returns true if the activity end date is after the given date.
|
static boolean | isActivityEndDateBefore(Activity activity, java.sql.Timestamp date)
This method returns true if the activity end date is before the given date.
|
static boolean | isActivityEndDateBefore(java.lang.Integer activityId, java.sql.Timestamp date)
This method returns true if the activity end date is before the given date.
|
static boolean | isActivityExpired(Activity activity)
This method returns true if the current timestamp is after the end date of the activity.
|
static boolean | isActivityStartDateAfter(Activity activity, java.sql.Timestamp date)
This method returns true if the activity start date is after the given date.
|
static boolean | isActivityStartDateAfter(java.lang.Integer activityId, java.sql.Timestamp date)
This method returns true if the activity start date is after the given date.
|
static boolean | isActivityStartDateBefore(Activity activity, java.sql.Timestamp date)
This method returns true if the activity start date is before the given date.
|
static boolean | isActivityStartDateBefore(java.lang.Integer activityId, java.sql.Timestamp date)
This method returns true if the activity start date is before the given date.
|
static boolean | isDateValidForActivity(Activity activity)
This method returns true if the current timestamp is in the range of valid dates for this activity.
|
static boolean | isDateValidForActivity(java.lang.Integer activityId)
This method returns true if the current timestamp is in the range of valid dates for this activity.
|
java.util.List | raiseEMSTrigger(ActivityTrigger activityTrigger)
This method handles the display of an EMarketingSpot.
|
java.util.List | raiseEMSTrigger(ActivityTrigger activityTrigger, java.util.List previewReport, java.util.Map temporarySharedData)
This method handles the display of an EMarketingSpot.
|
boolean | raiseTrigger(ActivityTrigger activityTrigger)
This method handles triggers sent to the trigger handler.
|
boolean | raiseTrigger(java.lang.String personalizationId, java.util.Map triggerParameters, java.lang.Integer storeId, java.lang.Integer triggerId, Activity activity)
This method handles timer triggers sent to the trigger handler.
|
boolean | raiseTrigger(java.lang.String personalizationId, java.util.Map triggerParameters, java.lang.Integer storeId, java.lang.Integer triggerId, Activity activity, java.util.Map temporarySharedData)
This method handles timer triggers sent to the trigger handler.
|
boolean | raiseTrigger(java.lang.String personalizationId, java.lang.String triggerParameters, java.lang.Integer storeId, java.lang.Integer triggerId, Activity activity)
This method handles timer triggers sent to the trigger handler.
|
void | raiseTrigger(java.lang.String personalizationId, java.lang.String triggerParameters, java.lang.Integer storeId, java.lang.Integer triggerId, java.lang.Integer activityId)
This method handles timer triggers sent to the trigger handler.
|
void | recordBehaviorXml(java.lang.String personalizationId, java.util.Map nvps, java.lang.Integer storeId)
This method records the given values to behavior column in the DMUSERBHVR database table for the specified user.
|
void | registerTriggerListener(java.lang.String triggerToListenFor, java.util.List nvps, java.lang.Integer activityId, java.lang.Integer storeId, java.lang.Integer triggerId, java.lang.Short allusers)
This method sets up an activity to start listening for a particular trigger.
|
void | registerTriggerSender(java.lang.Integer triggerId, java.lang.String personalizationId, java.sql.Timestamp triggerTime, java.lang.String triggerParameters, java.lang.Integer storeId)
This method sets up a timer trigger to be sent at a particular time in the future.
|
void | setEMSData(java.lang.String triggerParameters, java.util.List emsDataBeanList)
This method sets a EMarketingSpotDataBean to be returned to be displayed in an e-Marketing Spot.
|
static TriggerHandler | singleton()
This method returns the shared instance of the TriggerHandler object.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String TRIGGER_DISPLAYEMS
public static final java.lang.String TRIGGER_DISPLAYEMS_PARAMETER_EMS_ID
public static final java.lang.String TRIGGER_ACTIVITYACTION
public static final java.lang.String TRIGGER_TIMER
public static final java.lang.String XML_ATTRIBUTE_NAME_ACTIVITY_ID
public static final java.lang.String XML_ATTRIBUTE_ACTION
public static final java.lang.String ALL_USERS_TRUE
public static final java.lang.String MARKETING_SPOT_BEHAVIOR
public static final java.lang.String MARKETING_SPOT_BEHAVIOR_TIME_LIMIT
public static final java.lang.String RETURN_MARKETING_SPOT_BEHAVIOR_TIME_LIMIT
public static final int MARKETING_SPOT_BEHAVIOR_NO_TIME_LIMIT
public static final java.lang.String MARKETING_SPOT_BEHAVIOR_STATIC
public static final java.lang.String MARKETING_SPOT_BEHAVIOR_DYNAMIC
public static final java.lang.String MARKETING_SPOT_BEHAVIOR_DYNAMIC_WITH_REFRESH
public TriggerHandler()
public void registerTriggerListener(java.lang.String triggerToListenFor, java.util.List nvps, java.lang.Integer activityId, java.lang.Integer storeId, java.lang.Integer triggerId, java.lang.Short allusers)
public void registerTriggerSender(java.lang.Integer triggerId, java.lang.String personalizationId, java.sql.Timestamp triggerTime, java.lang.String triggerParameters, java.lang.Integer storeId)
protected com.ibm.commerce.marketing.internal.runtime.objects.TriggerListen[] findListeningActivity(ActivityTrigger activityTrigger)
protected com.ibm.commerce.marketing.internal.runtime.objects.TriggerListen[] findListeningActivity(ActivityTrigger activityTrigger, java.util.List previewReport)
protected com.ibm.commerce.marketing.internal.runtime.objects.TriggerListen[] findListeningActivity(ActivityTrigger activityTrigger, java.util.List previewReport, java.util.Map temporarySharedData)
public static boolean isActivityExpired(Activity activity)
public static boolean isDateValidForActivity(java.lang.Integer activityId)
public static boolean isDateValidForActivity(Activity activity)
public static boolean isActivityStartDateBefore(java.lang.Integer activityId, java.sql.Timestamp date)
public static boolean isActivityStartDateBefore(Activity activity, java.sql.Timestamp date)
public static boolean isActivityStartDateAfter(java.lang.Integer activityId, java.sql.Timestamp date)
public static boolean isActivityStartDateAfter(Activity activity, java.sql.Timestamp date)
public static boolean isActivityEndDateBefore(java.lang.Integer activityId, java.sql.Timestamp date)
public static boolean isActivityEndDateBefore(Activity activity, java.sql.Timestamp date)
public static boolean isActivityEndDateAfter(java.lang.Integer activityId, java.sql.Timestamp date)
public static boolean isActivityEndDateAfter(Activity activity, java.sql.Timestamp date)
public static boolean isActivityActive(java.lang.Integer activityId)
public static boolean isActivityActive(Activity activity)
public void incrementViewStatistics(java.lang.Integer activityId, java.lang.Integer emsId, java.lang.Integer storeId)
protected void incrementClickStatistics(java.lang.Integer activityId, java.lang.Integer emsId, java.lang.Integer storeId)
public void incrementTestElementViewStatistics(java.lang.Integer experimentId, java.lang.Integer testElementId, java.lang.Integer storeId)
protected void incrementTestElementClickStatistics(java.lang.Integer experimentId, java.lang.Integer testElementId, java.lang.Integer storeId)
public java.util.Map getAndResetEmsViewsCounter()
public java.util.Map getAndResetEmsClicksCounter()
public java.util.Map getAndResetTestElementViewsCounter()
public java.util.Map getAndResetTestElementClicksCounter()
public java.util.List raiseEMSTrigger(ActivityTrigger activityTrigger)
public static java.lang.String getBehaviorSetting(java.lang.String newBehavior, java.lang.String currentBehavior)
public java.lang.String getEMSBehavior(ActivityTrigger activityTrigger, java.lang.StringBuffer timeLimit)
public java.util.List raiseEMSTrigger(ActivityTrigger activityTrigger, java.util.List previewReport, java.util.Map temporarySharedData)
public boolean raiseTrigger(ActivityTrigger activityTrigger)
public void raiseTrigger(java.lang.String personalizationId, java.lang.String triggerParameters, java.lang.Integer storeId, java.lang.Integer triggerId, java.lang.Integer activityId)
public boolean raiseTrigger(java.lang.String personalizationId, java.lang.String triggerParameters, java.lang.Integer storeId, java.lang.Integer triggerId, Activity activity)
public boolean raiseTrigger(java.lang.String personalizationId, java.util.Map triggerParameters, java.lang.Integer storeId, java.lang.Integer triggerId, Activity activity)
public boolean raiseTrigger(java.lang.String personalizationId, java.util.Map triggerParameters, java.lang.Integer storeId, java.lang.Integer triggerId, Activity activity, java.util.Map temporarySharedData)
public void setEMSData(java.lang.String triggerParameters, java.util.List emsDataBeanList)
public void recordBehaviorXml(java.lang.String personalizationId, java.util.Map nvps, java.lang.Integer storeId)
public void forwardTriggers(java.lang.String triggerParameters, java.lang.String personalizationId, java.lang.Integer storeId, java.util.Map nvpsForSend, java.util.Map nvpsForRecord)
public void forwardTriggers(java.util.Map triggerParameters, java.lang.String personalizationId, java.lang.Integer storeId, java.util.Map nvpsForSend, java.util.Map nvpsForRecord)
public void initialize() throws java.lang.Exception
public static TriggerHandler singleton()