|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.p13n.property.AbstractConfigurableEntity com.bea.p13n.events.Event com.bea.p13n.tracking.events.TrackingEvent com.bea.p13n.tracking.events.SearchEvent
public class SearchEvent
Event for tracking user searches. This event is designed to track searches from, say, a user input on a web page. There are several fields which you can use for various purposes specific to your application, but see the docs of those methods for suggested vaules and usages. The general usage pattern is to create the event, then issue the search. After the search returns, set the response time and fire the event.
SearchEvent e = new SearchEvent( session, searchString ); e.setSearchContext( "myWebApp" ); e.setSearchTarget( "/content/base/monitor" ); e.setSearchType( "property" ); doSearch( searchString ); e.setResponseTime(); TrackingEventHelper.getEventService().dispatchEvent( e );
Field Summary | |
---|---|
static String |
SEARCH_CONTEXT
Attribute name for search expression |
static String |
SEARCH_EXPRESSION
Attribute name for search expression |
static String |
SEARCH_RESPONSE_MILLIS
Attribute name for search expression |
static String |
SEARCH_TARGET
Attribute name for search expression |
static String |
SEARCH_TYPE
Attribute name for search type |
static String |
TYPE
Event Type |
Fields inherited from class com.bea.p13n.tracking.events.TrackingEvent |
---|
REQUEST, SESSION_ID, USER_ID, USER_TYPE |
Fields inherited from class com.bea.p13n.property.AbstractConfigurableEntity |
---|
CE_METHOD_CACHE, instanceClass, PREFIX_GET, PREFIX_SET, propertyCache, textFormatter |
Fields inherited from interface com.bea.p13n.property.ConfigurableEntity |
---|
RESERVED_PROPERTY_SET |
Fields inherited from interface com.bea.p13n.events.EventConstants |
---|
TYPE_ALL |
Constructor Summary | |
---|---|
SearchEvent(javax.servlet.http.HttpServletRequest request,
String searchExpression)
Create a new SearchEvent. |
Method Summary | |
---|---|
void |
setSearchContext(String searchContext)
Set the search context. |
void |
setSearchExpression(String searchExpression)
Set the search expression. |
void |
setSearchResponseTime()
|
void |
setSearchTarget(String searchTarget)
Set the search target. |
void |
setSearchType(String searchType)
Set the search type. |
Methods inherited from class com.bea.p13n.tracking.events.TrackingEvent |
---|
getSchemaKeys, getSession, getXMLNamespace, getXSDFile, setSchemaKeys, setSession, setXMLNamespace, setXSDFile |
Methods inherited from class com.bea.p13n.events.Event |
---|
getApplication, getAttribute, getAttributeNames, getProperty, getTimeStamp, getType, removeAttribute, setApplication, setAttribute, setTimeStamp, toString |
Methods inherited from class com.bea.p13n.property.AbstractConfigurableEntity |
---|
createMapKey, getCachedProperty, getExplicitProperty, getExplicitSetter, getImplicitProperty, getJndiName, getPkString, getPropertyAsString, getPropertyCache, getPropertyNoDefault, getUniqueId, hasExplicitGetter, hasExplicitSetter, removeExplicitProperty, removeProperty, setExplicitProperty, setProperty, upcaseFirst |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.bea.p13n.property.ConfigurableEntity |
---|
getJndiName, getPkString, getPropertyAsString, getPropertyNoDefault, getUniqueId, removeProperty, setProperty |
Field Detail |
---|
public static final String TYPE
public static final String SEARCH_EXPRESSION
public static final String SEARCH_TYPE
public static final String SEARCH_CONTEXT
public static final String SEARCH_TARGET
public static final String SEARCH_RESPONSE_MILLIS
Constructor Detail |
---|
public SearchEvent(javax.servlet.http.HttpServletRequest request, String searchExpression)
request
- the http request. may be null if none is available, however
if the request is supplied, the base TrackingEvent will extract useful
data such as user id, etc, from the request.searchExpression
- the search expression. See setSearchExpression(java.lang.String)
.Method Detail |
---|
public void setSearchExpression(String searchExpression)
searchExpression
- the expressionpublic void setSearchType(String searchType)
searchType
- the type of searchpublic void setSearchTarget(String searchTarget)
searchTarget
- the target of the searchpublic void setSearchContext(String searchContext)
searchContext
- a context (source) from which the search was initiatedpublic void setSearchResponseTime()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |