com.plumtree.analytics.openusage
Interface IASEvent

All Known Subinterfaces:
IASPortalEvent, IDirViewEvent, IDocViewEvent, ILoginEvent, ILogoffEvent, IManagedEvent, IPageViewEvent, IPortletUseEvent, IPortletViewEvent, ISearchEvent, ISearchResultEvent

public interface IASEvent

This is the base interface for all Analytics Events

Author:
JamesHa

Method Summary
 IASEvent deserialize(byte[] bytes)
          Deserializes a byte array representing a serialized event and returns the deserialized IASEvent object
 java.lang.String getEventType()
          Returns the Event Type
 java.lang.Object getValue(java.lang.String name)
          Gets the value of the name/value property
 java.lang.String getVersion()
          Returns the Serializer Version
 void init(java.lang.String eventName)
          Initializes the ASEvent object with the given Event Name
 void sendEvent()
          Sends this event using the current configuration settings.
 byte[] serialize()
          Serializes this event and returns the serialized byte array
 void setConfig(java.lang.String fileLocation, java.lang.String fileName)
          Sets the openusage configuration using the property file at the given location and name
 void setConfig(com.plumtree.openfoundation.util.XPHashtable properties)
          Sets the openusage configuration using the given properties
 void setValue(java.lang.String name, java.lang.Object value)
          Sets a name/value property for this event
 

Method Detail

init

public void init(java.lang.String eventName)
Initializes the ASEvent object with the given Event Name

Parameters:
eventName - the event name (NULL is not allowed)

serialize

public byte[] serialize()
Serializes this event and returns the serialized byte array

Returns:
the serialized byte[] array (a NULL value indicates a serialization error)

deserialize

public IASEvent deserialize(byte[] bytes)
Deserializes a byte array representing a serialized event and returns the deserialized IASEvent object

Parameters:
bytes - a byte array representing a serialized event (NULL is not allowed)
Returns:
the deserialized IASEvent object (a NULL value indicates a serialization error)

setValue

public void setValue(java.lang.String name,
                     java.lang.Object value)
Sets a name/value property for this event

Parameters:
name - the property name (NULL is not allowed)
value - the property value (NULL is not allowed)

getValue

public java.lang.Object getValue(java.lang.String name)
Gets the value of the name/value property

Parameters:
name - the property name (NULL is not allowed)
Returns:
the property Object (a NULL value indicates that a property with the given name does not exist)

sendEvent

public void sendEvent()
Sends this event using the current configuration settings.

If the configuration was set using one of the setConfig methods, it will use this to transmit the event. Otherwise, it will use the configuration specified in PortalAnalyticsConfig.xml


getEventType

public java.lang.String getEventType()
Returns the Event Type

Returns:
the Event Type (will never be NULL)

getVersion

public java.lang.String getVersion()
Returns the Serializer Version

Returns:
the serializer Version (a NULL value indicates an event that was never serialized)

setConfig

public void setConfig(com.plumtree.openfoundation.util.XPHashtable properties)
Sets the openusage configuration using the given properties

Parameters:
properties - a hashtable containing the properties to set (NULL is not allowed)

setConfig

public void setConfig(java.lang.String fileLocation,
                      java.lang.String fileName)
Sets the openusage configuration using the property file at the given location and name

Parameters:
fileLocation - the directory where the file is located (NULL is not allowed)
fileName - the name of the file (NULL is not allowed)


Copyright © 2006 BEA Systems Inc. All Rights Reserved.