com.plumtree.analytics.openusage
Interface IDocViewEvent

All Superinterfaces:
IASEvent, IASPortalEvent

public interface IDocViewEvent
extends IASPortalEvent

Defines an event generated when a Document is viewed

Since:
3.0
Author:
James Hang

Method Summary
 java.lang.Integer getDocId()
          Returns the document ID
 java.lang.String getQueryId()
          Returns the Query ID
 boolean isCollabDoc()
          Determines if this is a Collaboration document
 void setCollabDoc(boolean isCollabDoc)
          Sets this as a Collaboration document
 void setDocId(java.lang.Integer docID)
          Sets the document ID
 void setQueryId(java.lang.String str)
          Sets the Query ID
 
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

getDocId

public java.lang.Integer getDocId()
Returns the document ID

Returns:
the document ID

setDocId

public void setDocId(java.lang.Integer docID)
Sets the document ID

Parameters:
docID - the document ID

getQueryId

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

Returns:
the Query ID

setQueryId

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


isCollabDoc

public boolean isCollabDoc()
Determines if this is a Collaboration document

Returns:
true if it's a Collabolation document

setCollabDoc

public void setCollabDoc(boolean isCollabDoc)
Sets this as a Collaboration document

Parameters:
isCollabDoc - is a Collaboration document


Copyright © 2006 BEA Systems Inc. All Rights Reserved.