com.plumtree.analytics.openusage
Interface IASPortalEvent

All Superinterfaces:
IASEvent
All Known Subinterfaces:
IDirViewEvent, IDocViewEvent, ILoginEvent, ILogoffEvent, IPageViewEvent, IPortletUseEvent, IPortletViewEvent, ISearchEvent, ISearchResultEvent

public interface IASPortalEvent
extends IASEvent

Defines an event generated from the Portal

Since:
3.0
Author:
James Hang

Method Summary
 java.lang.String getBrowser()
          Returns the Browser
 java.lang.String getClientAddress()
          Returns the Client Address
 java.lang.Integer getCommunityId()
          Returns the community ID
 java.lang.Integer getEventSource()
          Returns the Event Source
 java.lang.Integer getPageId()
          Returns the page ID
 java.lang.Integer getPortletId()
          Returns the portlet ID
 java.lang.String getReferrer()
          Returns the referer
 java.lang.Integer getResponseTime()
          Returns the response time (in milliseconds)
 java.lang.String getUrl()
          Returns the event url
 java.lang.Integer getUserId()
          Returns the Portal User ID
 void setBrowser(java.lang.String browser)
          Sets the Browser
 void setClientAddress(java.lang.String clientAddress)
          Sets the Client Address
 void setCommunityId(java.lang.Integer communityID)
          Sets the community ID
 void setEventSource(java.lang.Integer eventSource)
          Sets the Event Source
 void setPageId(java.lang.Integer pageID)
          Sets the page ID
 void setPortletId(java.lang.Integer portletID)
          Sets the portlet ID
 void setReferer(java.lang.String referer)
          Sets the referer
 void setResponseTime(java.lang.Integer responseTime)
          Sets the response time (in milliseconds)
 void setUrl(java.lang.String url)
          Sets the event url
 void setUserId(java.lang.Integer userId)
          Sets the Portal User ID
 
Methods inherited from interface com.plumtree.analytics.openusage.IASEvent
deserialize, getEventType, getValue, getVersion, init, sendEvent, serialize, setConfig, setConfig, setValue
 

Method Detail

getEventSource

public java.lang.Integer getEventSource()
Returns the Event Source

Returns:
the Event Source
See Also:
ASEventConstants.EVENT_SOURCE_PORTAL, ASEventConstants.EVENT_SOURCE_PEI, ASEventConstants.EVENT_SOURCE_SERVLET_FILTER, ASEventConstants.EVENT_SOURCE_HTTP_MODULE

setEventSource

public void setEventSource(java.lang.Integer eventSource)
Sets the Event Source

Parameters:
eventSource - the Event Source
See Also:
ASEventConstants.EVENT_SOURCE_PORTAL, ASEventConstants.EVENT_SOURCE_PEI, ASEventConstants.EVENT_SOURCE_SERVLET_FILTER, ASEventConstants.EVENT_SOURCE_HTTP_MODULE

getBrowser

public java.lang.String getBrowser()
Returns the Browser

Returns:
the Browser

setBrowser

public void setBrowser(java.lang.String browser)
Sets the Browser

Parameters:
browser - the Browser

getClientAddress

public java.lang.String getClientAddress()
Returns the Client Address

Returns:
the client address

setClientAddress

public void setClientAddress(java.lang.String clientAddress)
Sets the Client Address

Parameters:
clientAddress - the client address

getCommunityId

public java.lang.Integer getCommunityId()
Returns the community ID

Returns:
community ID

setCommunityId

public void setCommunityId(java.lang.Integer communityID)
Sets the community ID

Parameters:
communityID - the community ID

getPageId

public java.lang.Integer getPageId()
Returns the page ID

Returns:
the page ID

setPageId

public void setPageId(java.lang.Integer pageID)
Sets the page ID

Parameters:
pageID - the page ID

getPortletId

public java.lang.Integer getPortletId()
Returns the portlet ID

Returns:
the portlet ID

setPortletId

public void setPortletId(java.lang.Integer portletID)
Sets the portlet ID

Parameters:
portletID - the portlet ID

getReferrer

public java.lang.String getReferrer()
Returns the referer

Returns:
the referer

setReferer

public void setReferer(java.lang.String referer)
Sets the referer

Parameters:
referer - the referer

getResponseTime

public java.lang.Integer getResponseTime()
Returns the response time (in milliseconds)

Returns:
the response time

setResponseTime

public void setResponseTime(java.lang.Integer responseTime)
Sets the response time (in milliseconds)

Parameters:
responseTime - the response time

getUserId

public java.lang.Integer getUserId()
Returns the Portal User ID

Returns:
the User ID

setUserId

public void setUserId(java.lang.Integer userId)
Sets the Portal User ID

Parameters:
userId - the Portal User ID

getUrl

public java.lang.String getUrl()
Returns the event url

Returns:
the event url

setUrl

public void setUrl(java.lang.String url)
Sets the event url

Parameters:
url - the event url


Copyright © 2006 BEA Systems Inc. All Rights Reserved.