com.ibm.commerce.marketingcenter.events.runtime

Class MktgEventService

java.lang.Object

com.ibm.commerce.marketingcenter.events.runtime.MktgEventService

public class MktgEventService
extends java.lang.Object

This class defines the set of events that can be handled, and invokes the specific handler to handle the event. This class is primarily used as a target of controller/task commands that capture click events (allows reuse of those commands). It can be called in a runtime component as well (the alternative is to go to the database objects themselves and persist the event directly).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	EVTYPE_CPGN_CLICK Generic - an initiative was clicked on.
static java.lang.String	EVTYPE_EXPCPGN_CLICK An experimental campaign initiative was clicked on.
static java.lang.String	EVTYPE_PA_METAPHOR_INVOKED A Product Advisor metaphor (Product Comparison, Product Explorer, Sales Assistant) was invoked.
static java.lang.String	EVTYPE_PC_PRODDISP_CLICK Product Display was invoked through a click on Product Comparison.
static java.lang.String	EVTYPE_PC_PRODUCT_SHOWN At least one product was shown to the shopper.
static java.lang.String	EVTYPE_PE_CONSTRAINT_SEARCH A search was performed based on a specified constraint.
static java.lang.String	EVTYPE_SA_USERANSWER A particular survey question (aka concept) was answered.

Constructor Summary

Constructors

Constructor and Description
MktgEventService() Constructs a MktgEventService object.

Method Summary

Modifier and Type	Method and Description
static void	addClick(java.lang.String evtype, java.util.Hashtable h) Handles click events.
static void	addClick(java.lang.String evtype, com.ibm.commerce.datatype.TypedProperty tp) Handles click events.
static void	addClick(java.lang.String evtype, com.ibm.commerce.datatype.TypedProperty tp, java.lang.Integer storeIdentifier) Handles click events.
static void	addEvent(java.lang.String evtype, java.util.Hashtable h) Handles non-click events.
static void	addEvent(java.lang.String evtype, com.ibm.commerce.datatype.TypedProperty tp) Handles non-click events.
static void	addEvent(java.lang.String evtype, com.ibm.commerce.datatype.TypedProperty tp, java.lang.Integer storeIdentifier) Handles non-click events.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

EVTYPE_CPGN_CLICK

public static final java.lang.String EVTYPE_CPGN_CLICK

Generic - an initiative was clicked on. Set to CpgnClick.

See Also:

Constant Field Values

EVTYPE_EXPCPGN_CLICK

public static final java.lang.String EVTYPE_EXPCPGN_CLICK

An experimental campaign initiative was clicked on. Set to ExpCpgnClick.

See Also:

Constant Field Values

EVTYPE_PA_METAPHOR_INVOKED

public static final java.lang.String EVTYPE_PA_METAPHOR_INVOKED

A Product Advisor metaphor (Product Comparison, Product Explorer, Sales Assistant) was invoked. Set to PaInvoked.

See Also:

Constant Field Values

EVTYPE_PC_PRODDISP_CLICK

public static final java.lang.String EVTYPE_PC_PRODDISP_CLICK

Product Display was invoked through a click on Product Comparison. Set to PcProdDispClick.

See Also:

Constant Field Values

EVTYPE_PC_PRODUCT_SHOWN

public static final java.lang.String EVTYPE_PC_PRODUCT_SHOWN

At least one product was shown to the shopper. Set to PcProdDisp.

See Also:

Constant Field Values

EVTYPE_PE_CONSTRAINT_SEARCH

public static final java.lang.String EVTYPE_PE_CONSTRAINT_SEARCH

A search was performed based on a specified constraint. set to PeConstraintSearch.

See Also:

Constant Field Values

EVTYPE_SA_USERANSWER

public static final java.lang.String EVTYPE_SA_USERANSWER

A particular survey question (aka concept) was answered. Set to SaAnswer.

See Also:

Constant Field Values

Constructor Detail

MktgEventService

public MktgEventService()

Constructs a MktgEventService object.

Method Detail

addClick

public static void addClick(java.lang.String evtype,
                            java.util.Hashtable h)

Handles click events. The keys in the Hashtable should be the same as the column names in the database table. What is actually contained in the Hashtable is dependent on what the handler class does but in general, it should contain the components of the primary key (since we are likely updating a click counter).

Parameters:

evtype - An event type defined in MktgEventService class

h - A Hashtable containing all the relevant information to process the event.

addClick

public static void addClick(java.lang.String evtype,
                            com.ibm.commerce.datatype.TypedProperty tp)

Handles click events. The keys in the TypedProperty should be the same as the column names in the database table. What is actually contained in the TypedProperty is dependent on what the handler class does but in general, it should contain the components of the primary key (since we are likely updating a click counter).

Parameters:

evtype - An event type defined in MktgEventService class

tp - A TypedProperty containing all the relevant information to process the event.

addClick

public static void addClick(java.lang.String evtype,
                            com.ibm.commerce.datatype.TypedProperty tp,
                            java.lang.Integer storeIdentifier)

Handles click events. The keys in the TypedProperty should be the same as the column names in the database table. What is actually contained in the TypedProperty is dependent on what the handler class does but in general, it should contain the components of the primary key (since we are likely updating a click counter).

Parameters:

evtype - An event type defined in MktgEventService class

tp - A TypedProperty containing all the relevant information to process the event.

storeIdentifier - The store id.

addEvent

public static void addEvent(java.lang.String evtype,
                            java.util.Hashtable h)

Handles non-click events. The keys in the Hashtable should be the same as the column names in the database table. What is actually contained in the Hashtable is dependent on what the handler class does. For example, if events are captured in a log, then the Hashtable should contain all the information to populate a row within the database table.

Parameters:

evtype - An event type defined in MktgEventService class.

h - A Hashtable containing all the relevant information to process the event.

addEvent

public static void addEvent(java.lang.String evtype,
                            com.ibm.commerce.datatype.TypedProperty tp)

Handles non-click events. The keys in the TypedProperty should be the same as the column names in the database table. What is actually contained in the TypedProperty is dependent on what the handler class does. For example, if events are captured in a log, then the Hashtable should contain all the information to populate a row within the database table.

Parameters:

evtype - An event type defined in MktgEventService class

tp - A TypedProperty containing all the relevant information to process the event.

addEvent

public static void addEvent(java.lang.String evtype,
                            com.ibm.commerce.datatype.TypedProperty tp,
                            java.lang.Integer storeIdentifier)

Handles non-click events. The keys in the TypedProperty should be the same as the column names in the database table. What is actually contained in the TypedProperty is dependent on what the handler class does. For example, if events are captured in a log, then the Hashtable should contain all the information to populate a row within the database table.

Parameters:

evtype - An event type defined in MktgEventService class

tp - A TypedProperty containing all the relevant information to process the event.

storeIdentifier - The store id.