com.plumtree.analytics.openusage
Interface IManagedEvent

All Superinterfaces:
IASEvent

public interface IManagedEvent
extends IASEvent

Defines an event that has been registered and managed by the Analytics server. A ManagedEvent is defined by the event name that was given when the event was registered. Each of the event's parameters can be set using one of the typed set methods and passing the name of the parameter and it's typed value. For parameters that point to managed dimensions, set the parameter's value as a ManagedDimension object -

Since:
3.0
Author:
James Hang
See Also:
ManagedDimension

Method Summary
 ManagedDimension getDimensionParameter(java.lang.String parameterName)
          Gets the dimension parameter in this event with the name parameterName
 java.lang.Object getFact(java.lang.String factName)
          Deprecated.  
 java.lang.Object getParameter(java.lang.String parameterName)
          Get the value of the parameter as an Object
 java.lang.Integer getUserId()
          Deprecated.  
 void setFact(java.lang.String factName, java.lang.Double value)
          Deprecated.  
 void setFact(java.lang.String factName, java.lang.Float value)
          Deprecated.  
 void setFact(java.lang.String factName, java.lang.Integer value)
          Deprecated.  
 void setFact(java.lang.String factName, java.lang.Long value)
          Deprecated.  
 void setFact(java.lang.String factName, java.lang.String value)
          Deprecated.  
 void setFact(java.lang.String factName, com.plumtree.openfoundation.util.XPDateTime value)
          Deprecated.  
 void setLongAsDateFact(java.lang.String factName, java.lang.Long value)
          Deprecated.  
 void setLongAsDateParameter(java.lang.String parameterName, java.lang.Long value)
          Set a Date parameter using a Long value
 void setParameter(java.lang.String parameterName, java.lang.Boolean value)
          Set a Boolean parameter value
 void setParameter(java.lang.String parameterName, java.lang.Double value)
          Set a Double parameter value
 void setParameter(java.lang.String parameterName, java.lang.Float value)
          Set a Float parameter value
 void setParameter(java.lang.String parameterName, java.lang.Integer value)
          Set an Integer parameter value
 void setParameter(java.lang.String parameterName, java.lang.Long value)
          Set a Long parameter value
 void setParameter(java.lang.String parameterName, java.lang.String value)
          Set a String parameter value
 void setParameter(java.lang.String parameterName, com.plumtree.openfoundation.util.XPDateTime value)
          Set a Date parameter value
 void setUserId(java.lang.Integer userId)
          Deprecated.  
 
Methods inherited from interface com.plumtree.analytics.openusage.IASEvent
deserialize, getEventType, getValue, getVersion, init, sendEvent, serialize, setConfig, setConfig, setValue
 

Method Detail

setParameter

public void setParameter(java.lang.String parameterName,
                         java.lang.String value)
Set a String parameter value

Parameters:
parameterName - the name of the parameter
value - the value to set

setParameter

public void setParameter(java.lang.String parameterName,
                         java.lang.Integer value)
Set an Integer parameter value

Parameters:
parameterName - the name of the parameter
value - the value to set

setParameter

public void setParameter(java.lang.String parameterName,
                         java.lang.Long value)
Set a Long parameter value

Parameters:
parameterName - the name of the parameter
value - the value to set

setParameter

public void setParameter(java.lang.String parameterName,
                         java.lang.Float value)
Set a Float parameter value

Parameters:
parameterName - the name of the parameter
value - the value to set

setParameter

public void setParameter(java.lang.String parameterName,
                         java.lang.Double value)
Set a Double parameter value

Parameters:
parameterName - the name of the parameter
value - the value to set

setParameter

public void setParameter(java.lang.String parameterName,
                         java.lang.Boolean value)
Set a Boolean parameter value

Parameters:
parameterName - the name of the parameter
value - the value to set

setParameter

public void setParameter(java.lang.String parameterName,
                         com.plumtree.openfoundation.util.XPDateTime value)
Set a Date parameter value

Parameters:
parameterName - the name of the parameter
value - the value to set

getDimensionParameter

public ManagedDimension getDimensionParameter(java.lang.String parameterName)
Gets the dimension parameter in this event with the name parameterName

Parameters:
parameterName - the name of the dimension parameter

setLongAsDateParameter

public void setLongAsDateParameter(java.lang.String parameterName,
                                   java.lang.Long value)
Set a Date parameter using a Long value

Parameters:
parameterName - the name of the parameter
value - the value to set

getParameter

public java.lang.Object getParameter(java.lang.String parameterName)
Get the value of the parameter as an Object

Parameters:
parameterName - the name of the parameter

setFact

public void setFact(java.lang.String factName,
                    java.lang.String value)
Deprecated.  

Set a String fact value

Parameters:
factName - the name of the fact
value - the value to set

setFact

public void setFact(java.lang.String factName,
                    java.lang.Integer value)
Deprecated.  

Set an Integer fact value

Parameters:
factName - the name of the fact
value - the value to set

setFact

public void setFact(java.lang.String factName,
                    java.lang.Long value)
Deprecated.  

Set a Long fact value

Parameters:
factName - the name of the fact
value - the value to set

setFact

public void setFact(java.lang.String factName,
                    java.lang.Float value)
Deprecated.  

Set a Float fact value

Parameters:
factName - the name of the fact
value - the value to set

setFact

public void setFact(java.lang.String factName,
                    java.lang.Double value)
Deprecated.  

Set a Double fact value

Parameters:
factName - the name of the fact
value - the value to set

setFact

public void setFact(java.lang.String factName,
                    com.plumtree.openfoundation.util.XPDateTime value)
Deprecated.  

Set a Date fact value

Parameters:
factName - the name of the fact
value - the value to set

setLongAsDateFact

public void setLongAsDateFact(java.lang.String factName,
                              java.lang.Long value)
Deprecated.  

Set a Date fact using a Long value

Parameters:
factName - the name of the fact
value - the value to set

getFact

public java.lang.Object getFact(java.lang.String factName)
Deprecated.  

Get the value of the fact as an Object

Parameters:
factName - the name of the fact

getUserId

public java.lang.Integer getUserId()
Deprecated.  

Returns the User ID

Returns:
the User ID

setUserId

public void setUserId(java.lang.Integer userId)
Deprecated.  

Sets the User ID

Parameters:
userId - the User ID


Copyright © 2006 BEA Systems Inc. All Rights Reserved.