com.plumtree.analytics.openusage
Interface ISearchEvent

All Superinterfaces:
IASEvent, IASPortalEvent

public interface ISearchEvent
extends IASPortalEvent

Defines an event generated when a Search is executed

Since:
3.0
Author:
James Hang

Method Summary
 java.lang.String getQueryId()
          Returns the Query ID
 java.lang.Integer getSearchRank()
          Returns the search rank
 java.lang.String getSearchString()
          Returns the search string
 java.lang.String getSearchType()
          Returns the search type
 void setQueryId(java.lang.String queryID)
          Sets the Query ID
 void setSearchRank(java.lang.Integer searchRank)
          Sets the search rank
 void setSearchString(java.lang.String searchString)
          Sets the search string
 void setSearchType(java.lang.String searchType)
          Sets the search type
 
Methods inherited from interface com.plumtree.analytics.openusage.IASPortalEvent
getBrowser, getClientAddress, getCommunityId, getEventSource, getPageId, getPortletId, getReferrer, getResponseTime, getUrl, getUserId, setBrowser, setClientAddress, setCommunityId, setEventSource, setPageId, setPortletId, setReferer, setResponseTime, setUrl, setUserId
 
Methods inherited from interface com.plumtree.analytics.openusage.IASEvent
deserialize, getEventType, getValue, getVersion, init, sendEvent, serialize, setConfig, setConfig, setValue
 

Method Detail

getSearchRank

public java.lang.Integer getSearchRank()
Returns the search rank

Returns:
the search rank

setSearchRank

public void setSearchRank(java.lang.Integer searchRank)
Sets the search rank


getQueryId

public java.lang.String getQueryId()
Returns the Query ID

Returns:
the Query ID

setQueryId

public void setQueryId(java.lang.String queryID)
Sets the Query ID


getSearchString

public java.lang.String getSearchString()
Returns the search string

Returns:
the search string

setSearchString

public void setSearchString(java.lang.String searchString)
Sets the search string

Parameters:
searchString - the search string

getSearchType

public java.lang.String getSearchType()
Returns the search type

Returns:
the search type
See Also:
ASEventConstants.BASIC_SEARCH_TYPE, ASEventConstants.ADVANCED_SEARCH_TYPE

setSearchType

public void setSearchType(java.lang.String searchType)
Sets the search type

Parameters:
searchType - the search type
See Also:
ASEventConstants.BASIC_SEARCH_TYPE, ASEventConstants.ADVANCED_SEARCH_TYPE


Copyright © 2006 BEA Systems Inc. All Rights Reserved.