# com.bea.p13n.tracking.events
TrackingEvent Class

public abstract class TrackingEvent
extends `Event`

The base class for implementing any behavior tracking events. Events that will be persisted to the EVENT table for beahvior tracking must subclass this class.

Hierarchy
  `Object`
  `AbstractConfigurableEntity`
  `Event`
  `TrackingEvent`

All Implemented Interfaces
  `ConfigurableEntity`, `EventConstants`, `Serializable`

Direct Known Subclasses
  `CampaignUserActivityEvent`, `ClickEvent`, `ContentEvent`, `GenericTrackingEvent`, `RuleEvent`, `SessionBeginEvent`, `SessionEndEvent`, `SessionLoginEvent`, `ShoppingEvent`, `UserRegistrationEvent`

## Field Summary

`public static final `String`` | `APPLICATION` Event attribute key name for the WebLogic application context Attribute value is a String
`public static final `String`` | `REQUEST` Event attribute key name for the request object Attribute value is a com.bea.p13n.http.Request
`public static final `String`` | `SESSION_ID` Event attribute key name for session id Attribute value is a String
`public static final `String`` | `USER_ID` Event attribute key name for user id Attribute value is a String
`public static final `String`` | `USER_TYPE` Event attribute key name for user type.

Fields from com.bea.p13n.property`.`AbstractConfigurableEntity``
``CE_METHOD_CACHE`, `instanceClass`, `PREFIX_GET`, `PREFIX_SET`, `propertyCache`, `textFormatter``

Fields from interface com.bea.p13n.property`.`ConfigurableEntity``
``RESERVED_PROPERTY_SET``

Fields from interface com.bea.p13n.events`.`EventConstants``
``TYPE_ALL``

## Constructor Summary

TrackingEvent(`String` theEventType, `String` theSessionId, `String` theUserId, `String` theXMLNamespace, `String` theXSDFile, `String` theSchemaKeys, `HttpServletRequest` theRequest) Create a new TrackingEvent.
TrackingEvent(`String` theEventType, `String` theSessionId, `String` theUserId, `String` theXMLNamespace, `String` theXSDFile, `String` theSchemaKeys) Create a new TrackingEvent.
TrackingEvent(`String` theEventType, `HttpSession` session, `String` theXMLNamespace, `String` theXSDFile, `String` theSchemaKeys, `HttpServletRequest` theRequest) Create a new TrackingEvent.
TrackingEvent(`String` eventType, `HttpSession` session, `String` theXMLNamespace, `String` theXSDFile, `String` theSchemaKeys) Create a new TrackingEvent.

## Method Summary

`public `String`[]` | `getSchemaKeys`() Get the schama keys (and their order) for the XML representation of this document
`public `HttpSession`` | `getSession`()
`public `String`` | `getXMLNamespace`() Get the XML namespace for this event
`public `String`` | `getXSDFile`() Get the XSD schema file for this event
`public void` | `setSchemaKeys`(`String`[] schemaKeys) Get the schema keys for this event's XML representation
`public void` | `setSession`(`HttpSession` session) HttpSession object
`public void` | `setXMLNamespace`(`String` newXMLNamespace) Set the XML namespace for this event
`public void` | `setXSDFile`(`String` newXSDFile) Set the XSD schema file for this event

Methods from `com.bea.p13n.events.`Event``
``getApplication`, `getAttribute`, `getAttributeNames`, `getProperty`, `getTimeStamp`, `getType`, `removeAttribute`, `setApplication`, `setAttribute`, `toString``

Methods from `com.bea.p13n.property.`AbstractConfigurableEntity``
``createMapKey`, `getCachedProperty`, `getExplicitProperty`, `getExplicitSetter`, `getImplicitProperty`, `getJndiName`, `getPkString`, `getProperty`, `getPropertyAsString`, `getPropertyCache`, `getPropertyNoDefault`, `getUniqueId`, `hasExplicitGetter`, `hasExplicitSetter`, `removeExplicitProperty`, `removeProperty`, `setExplicitProperty`, `setProperty`, `upcaseFirst``

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `com.bea.p13n.property.`ConfigurableEntity``
``getJndiName`, `getPkString`, `getProperty`, `getPropertyAsString`, `getPropertyNoDefault`, `getUniqueId`, `removeProperty`, `setProperty``

## Field Detail

### APPLICATION

    public static final String APPLICATION

  Event attribute key name for the WebLogic application context Attribute value is a String

### REQUEST

    public static final String REQUEST

  Event attribute key name for the request object Attribute value is a com.bea.p13n.http.Request

### SESSION_ID

    public static final String SESSION_ID

  Event attribute key name for session id Attribute value is a String

### USER_ID

    public static final String USER_ID

  Event attribute key name for user id Attribute value is a String

### USER_TYPE

    public static final String USER_TYPE

  Event attribute key name for user type. Attribute value is a String

Related Topics

``ProfileType``

## Constructor Detail

### TrackingEvent

    public TrackingEvent(String theEventType,
                         String theSessionId,
                         String theUserId,
                         String theXMLNamespace,
                         String theXSDFile,
                         String[] theSchemaKeys,
                         HttpServletRequest theRequest)

  Create a new TrackingEvent.

### TrackingEvent

    public TrackingEvent(String theEventType,
                         String theSessionId,
                         String theUserId,
                         String theXMLNamespace,
                         String theXSDFile,
                         String[] theSchemaKeys)

  Create a new TrackingEvent.

### TrackingEvent

    public TrackingEvent(String theEventType,
                         HttpSession session,
                         String theXMLNamespace,
                         String theXSDFile,
                         String[] theSchemaKeys,
                         HttpServletRequest theRequest)

  Create a new TrackingEvent. We'll get the sessionId, userId, and profileType all from the Session object. This API should be used instead of the deprecated constructors.

### TrackingEvent

    public TrackingEvent(String eventType,
                         HttpSession session,
                         String theXMLNamespace,
                         String theXSDFile,
                         String[] theSchemaKeys)

  Create a new TrackingEvent. We'll get the sessionId, userId, and profileType all from the Session object. This API should be used instead of the deprecated constructors.

## Method Detail

### getSchemaKeys() Method

    public String[] getSchemaKeys()

Get the schama keys (and their order) for the XML representation of this document

### getSession() Method

    public HttpSession getSession()

### getXMLNamespace() Method

    public String getXMLNamespace()

Get the XML namespace for this event

### getXSDFile() Method

    public String getXSDFile()

Get the XSD schema file for this event

### setSchemaKeys(String[]) Method

    public void setSchemaKeys(String[] schemaKeys)

Get the schema keys for this event's XML representation

### setSession(HttpSession) Method

    public void setSession(HttpSession session)

HttpSession object

### setXMLNamespace(String) Method

    public void setXMLNamespace(String newXMLNamespace)

Set the XML namespace for this event

### setXSDFile(String) Method

    public void setXSDFile(String newXSDFile)

Set the XSD schema file for this event