Interface AnalyticsEventPropertyResolver


@Exported public interface AnalyticsEventPropertyResolver
Provides an extendable way to map properties of an Activity Streaming activity to properties of an analytics event of corresponding type.
Since:
release specific (what release of product did this appear in)
  • Method Summary

    Modifier and Type
    Method
    Description
    getProperty(ActivityElement activity, String eventType, String factName, String factDimensionProperty)
    Expected to return the value to be used for the specified event parameter / event dimension property in an event that is to be generated for the specified activity instance.
  • Method Details

    • getProperty

      Object getProperty(ActivityElement activity, String eventType, String factName, String factDimensionProperty) throws ActivityException
      Expected to return the value to be used for the specified event parameter / event dimension property in an event that is to be generated for the specified activity instance.

      For instance, for an event of type "WC:DISCUSSION_FORUMCREATE", parameter "DICUSSION_FORUM", and dimension property "RESOURCE_ID", this method is expected to look up the first object argument of the passed activity, and return its object id.

      Parameters:
      activity - Activity Streaming activity for which to return the event property value
      eventType - Name of the analytics event type
      factName - Name of an event parameter or event dimension parameter for the specified event type
      factDimensionProperty - Name of a property of the dimension of the specified dimension parameter if factName is for a dimension parameter, or null if factName is not for a dimension parameter but for a simple parameter
      Throws:
      ActivityException - If an error occurs that prevents the resolver from being able to successfully resolve the requested property