com.bea.commerce.campaign.tracking.events
Class ClickCampaignEvent

java.lang.Object
  |
  +--com.beasys.commerce.foundation.AbstractConfigurableEntity
        |
        +--com.bea.commerce.platform.events.Event
              |
              +--com.bea.commerce.platform.tracking.events.TrackingEvent
                    |
                    +--com.bea.commerce.platform.tracking.events.ClickEvent
                          |
                          +--com.bea.commerce.campaign.tracking.events.ClickCampaignEvent

All Implemented Interfaces:

BusinessPolicyManager, ConfigurableEntity, EventConstants, java.io.Serializable

public class ClickCampaignEvent

extends ClickEvent

Event for tracking click of campaign

See Also:

Serialized Form

Field Summary

static java.lang.String	APPLICATION_NAME Event attribute key name for storefront (aka application) Attribute value is a String
static java.lang.String	BANNER_AD_PROMOTION Suggestions for entry into the documentType data passed to the constructor Attribute value is a String
static java.lang.String	CAMPAIGN_ID Event attribute key name for the campaign id Attribute value is a String
static java.lang.String	PLACEHOLDER_ID Event attribute key name for item category id Attribute value is a String
static java.lang.String	SCENARIO_ID Event attribute key name for the scenario id Attribute value is a String
static java.lang.String	TYPE The event type

Fields inherited from class com.bea.commerce.platform.tracking.events.ClickEvent

DOCUMENT_ID, DOCUMENT_TYPE

Fields inherited from class com.bea.commerce.platform.tracking.events.TrackingEvent

REQUEST, SESSION_ID, USER_ID

Fields inherited from interface com.beasys.commerce.foundation.ConfigurableEntity

RESERVED_SCOPE_NAME

Fields inherited from interface com.bea.commerce.platform.events.EventConstants

ASYNCHRONOUS_LISTENER_CLASSES_PROPERTY, EVENT_LISTENER_CLASSES_PROPERTY, EVENT_MESSAGE_CATALOG, ILLEGAL_ARGUMENT_EXCEPTION_NULL_TYPE, LISTENER_CREATE_EXCEPTION, NULL_POINTER_EXCEPTION_ATTRIBUTE_KEY, TYPE_ALL

Constructor Summary

ClickCampaignEvent(java.lang.String theSessionId, java.lang.String theUserId, javax.servlet.http.HttpServletRequest theRequest, java.lang.String aDocumentType, java.lang.String aDocumentId, java.lang.String aCampaignId, java.lang.String aScenarioId, java.lang.String aApplicationName, java.lang.String aPlaceholderId)
Create a new ClickCampaignEvent.

Methods inherited from class com.bea.commerce.platform.tracking.events.TrackingEvent

getSchemaKeys, getXMLNamespace, getXSDFile, setSchemaKeys, setXMLNamespace, setXSDFile

Methods inherited from class com.bea.commerce.platform.events.Event

getAttribute, getAttributeNames, getProperty, getTimeStamp, getType, removeAttribute, setAttribute, toString

Methods inherited from class com.beasys.commerce.foundation.AbstractConfigurableEntity

addBusinessPolicy, addPropertyValue, addPropertyValueMapped, getBusinessPolicy, getPersistableHandle, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDefault, getPropertyNoDefault, getSuccessor, getUniqueId, removeBusinessPolicy, removeProperty, removeProperty, removePropertyValue, removePropertyValueMapped, removeSuccessor, setProperty, setProperty, setSuccessor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.beasys.commerce.foundation.ConfigurableEntity

addPropertyValue, addPropertyValueMapped, getPersistableHandle, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDefault, getPropertyNoDefault, getSuccessor, getUniqueId, removeProperty, removeProperty, removePropertyValue, removePropertyValueMapped, removeSuccessor, setProperty, setProperty, setSuccessor

Methods inherited from interface com.beasys.commerce.foundation.BusinessPolicyManager

addBusinessPolicy, getBusinessPolicy, removeBusinessPolicy

Field Detail

TYPE

public static final java.lang.String TYPE

The event type

CAMPAIGN_ID

public static final java.lang.String CAMPAIGN_ID

Event attribute key name for the campaign id Attribute value is a String

SCENARIO_ID

public static final java.lang.String SCENARIO_ID

Event attribute key name for the scenario id Attribute value is a String

APPLICATION_NAME

public static final java.lang.String APPLICATION_NAME

Event attribute key name for storefront (aka application) Attribute value is a String

PLACEHOLDER_ID

public static final java.lang.String PLACEHOLDER_ID

Event attribute key name for item category id Attribute value is a String

BANNER_AD_PROMOTION

public static final java.lang.String BANNER_AD_PROMOTION

Suggestions for entry into the documentType data passed to the constructor Attribute value is a String

Constructor Detail

ClickCampaignEvent

public ClickCampaignEvent(java.lang.String theSessionId,
                          java.lang.String theUserId,
                          javax.servlet.http.HttpServletRequest theRequest,
                          java.lang.String aDocumentType,
                          java.lang.String aDocumentId,
                          java.lang.String aCampaignId,
                          java.lang.String aScenarioId,
                          java.lang.String aApplicationName,
                          java.lang.String aPlaceholderId)

Create a new ClickCampaignEvent.

Parameters:

theSessionId - from HttpSession.getId()

theUserId - from HttpServletRequest.getRemoteUser() or equivalent (null if unknown)

theRequest - the http servlet request object

aDocumentType - Document Type for the clicked content (optionally null)

aDocumentId - Document ID for the clicked content (optionally null)

aCampaignId - campaign id for the campaign from which the item was clicked

aScenarioId - scenario id for the scenario (within the campaign) for which the item was clicked

aApplicationName - application name (aka storefront) (optionally null)

aPlaceholderId - a placeholder id