CampaignEventUtilities

java.lang.Object
- com.ibm.commerce.marketingcenter.events.util.CampaignEventUtilities

```
public class CampaignEventUtilities
extends java.lang.Object
```
Utility methods to send a campaign logging event, serialize the logging data into the common base event, and retrieve the data from the common base event.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CAMPAIGN` Campaign Logging event data element constant in the common base event for the overall campaign logging data object.
`static java.lang.String`	`CAMPAIGN_ID` Campaign Logging event data element constant for the campaign ID.
`static java.lang.String`	`CAMPAIGN_LOGGING_EVENT` The campaign logging event name.
`static java.lang.String`	`CAMPAIGN_NAME` Campaign Logging event data element constant for the campaign name.
`static java.lang.String`	`CLICKED` Campaign Logging event data element constant for the flag that indicates whether or not the campaign was clicked.
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.
`static java.lang.String`	`EMARKETINGSPOT_ID` Campaign Logging event data element constant for the e-Marketing Spot ID.
`static java.lang.String`	`EMARKETINGSPOT_NAME` Campaign Logging event data element constant for the e-Marketing Spot name.
`static java.lang.String`	`EMARKETINGSPOT_TYPE_ID` Campaign Logging event data element constant for the e-Marketing Spot type ID.
`static java.lang.String`	`EMARKETINGSPOT_TYPE_NAME` Campaign Logging event data element constant for the e-Marketing Spot type name.
`static java.lang.String`	`INITIATIVE_ID` Campaign Logging event data element constant for the initiative ID.
`static java.lang.String`	`INITIATIVE_NAME` Campaign Logging event data element constant for the initiative name.
`static java.lang.String`	`RESULTS` Campaign Logging event data element constant for the campaign results.
`static java.lang.String`	`SHOP_SEGMENTS` Campaign Logging event data element constant for the customer segment identifiers.
`static java.lang.String`	`STORE_ID` Campaign Logging event data element constant for the store ID.
`static java.lang.String`	`USRTRAFFIC_ID` Campaign Logging event data element constant for the user traffic ID.
`static java.lang.String`	`VIEWED` Campaign Logging event data element constant for the flag that indicates whether or not the campaign was viewed.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static CampaignLoggingDataBean`	`getCampaignLoggingData(CommonBaseEvent cbe)` This method extracts the campaign logging data from the common base event.
`static void`	`sendCampaignLoggingEvent(CampaignLoggingDataBean campaignLogData)` This method sends a campaign logging event to the event infrastructure for processing.
`static void`	`sendCampaignLoggingEvent(CampaignLoggingDataBean campaignLogData, com.ibm.commerce.command.CommandContext context)` This method sends a campaign logging event to the event infrastructure for processing.
`static void`	`serializeCampaignLoggingData(CommonBaseEvent cbe, CampaignLoggingDataBean campaignLogData)` This method serializes the campaign logging data and stores it in the common base event.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CAMPAIGN
```
public static final java.lang.String CAMPAIGN
```
    Campaign Logging event data element constant in the common base event for the overall campaign logging data object.
    
    See Also:
    
    Constant Field Values
  - CAMPAIGN_ID
```
public static final java.lang.String CAMPAIGN_ID
```
    Campaign Logging event data element constant for the campaign ID.
    
    See Also:
    
    Constant Field Values
  - CAMPAIGN_LOGGING_EVENT
```
public static final java.lang.String CAMPAIGN_LOGGING_EVENT
```
    The campaign logging event name. There is an event container and an event factory with this name.
    
    See Also:
    
    Constant Field Values
  - CAMPAIGN_NAME
```
public static final java.lang.String CAMPAIGN_NAME
```
    Campaign Logging event data element constant for the campaign name.
    
    See Also:
    
    Constant Field Values
  - CLICKED
```
public static final java.lang.String CLICKED
```
    Campaign Logging event data element constant for the flag that indicates whether or not the campaign was clicked.
    
    See Also:
    
    Constant Field Values
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - EMARKETINGSPOT_ID
```
public static final java.lang.String EMARKETINGSPOT_ID
```
    Campaign Logging event data element constant for the e-Marketing Spot ID.
    
    See Also:
    
    Constant Field Values
  - EMARKETINGSPOT_NAME
```
public static final java.lang.String EMARKETINGSPOT_NAME
```
    Campaign Logging event data element constant for the e-Marketing Spot name.
    
    See Also:
    
    Constant Field Values
  - EMARKETINGSPOT_TYPE_ID
```
public static final java.lang.String EMARKETINGSPOT_TYPE_ID
```
    Campaign Logging event data element constant for the e-Marketing Spot type ID.
    
    See Also:
    
    Constant Field Values
  - EMARKETINGSPOT_TYPE_NAME
```
public static final java.lang.String EMARKETINGSPOT_TYPE_NAME
```
    Campaign Logging event data element constant for the e-Marketing Spot type name.
    
    See Also:
    
    Constant Field Values
  - INITIATIVE_ID
```
public static final java.lang.String INITIATIVE_ID
```
    Campaign Logging event data element constant for the initiative ID.
    
    See Also:
    
    Constant Field Values
  - INITIATIVE_NAME
```
public static final java.lang.String INITIATIVE_NAME
```
    Campaign Logging event data element constant for the initiative name.
    
    See Also:
    
    Constant Field Values
  - RESULTS
```
public static final java.lang.String RESULTS
```
    Campaign Logging event data element constant for the campaign results.
    
    See Also:
    
    Constant Field Values
  - SHOP_SEGMENTS
```
public static final java.lang.String SHOP_SEGMENTS
```
    Campaign Logging event data element constant for the customer segment identifiers.
    
    See Also:
    
    Constant Field Values
  - STORE_ID
```
public static final java.lang.String STORE_ID
```
    Campaign Logging event data element constant for the store ID.
    
    See Also:
    
    Constant Field Values
  - USRTRAFFIC_ID
```
public static final java.lang.String USRTRAFFIC_ID
```
    Campaign Logging event data element constant for the user traffic ID.
    
    See Also:
    
    Constant Field Values
  - VIEWED
```
public static final java.lang.String VIEWED
```
    Campaign Logging event data element constant for the flag that indicates whether or not the campaign was viewed.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCampaignLoggingData
```
public static CampaignLoggingDataBean getCampaignLoggingData(CommonBaseEvent cbe)
```
    This method extracts the campaign logging data from the common base event.
    
    Parameters:
    
    cbe - The common base event.
    
    Returns:
    
    The campaign logging data that the event contains. If the event does not contain any campaign logging data, null will be returned.
  - sendCampaignLoggingEvent
```
public static void sendCampaignLoggingEvent(CampaignLoggingDataBean campaignLogData)
```
    This method sends a campaign logging event to the event infrastructure for processing. When the scheduled RaiseECEvent command runs, it will process the events, and forward them to the appropriate event listeners.
    
    Parameters:
    
    campaignLogData - The campaign log data.
  - sendCampaignLoggingEvent
```
public static void sendCampaignLoggingEvent(CampaignLoggingDataBean campaignLogData,
                                            com.ibm.commerce.command.CommandContext context)
```
    This method sends a campaign logging event to the event infrastructure for processing. When the scheduled RaiseECEvent command runs, it will process the events, and forward them to the appropriate event listeners.
    
    Parameters:
    
    campaignLogData - The campaign log data.
    
    context - The command context.
  - serializeCampaignLoggingData
```
public static void serializeCampaignLoggingData(CommonBaseEvent cbe,
                                                CampaignLoggingDataBean campaignLogData)
```
    This method serializes the campaign logging data and stores it in the common base event.
    
    Parameters:
    
    cbe - The common base event.
    
    campaignLogData - The campaign logging data.

Methods inherited from class java.lang.Object

CAMPAIGN

CAMPAIGN_ID

CAMPAIGN_LOGGING_EVENT

CAMPAIGN_NAME

CLICKED

COPYRIGHT

EMARKETINGSPOT_ID

EMARKETINGSPOT_NAME

EMARKETINGSPOT_TYPE_ID

EMARKETINGSPOT_TYPE_NAME

INITIATIVE_ID

INITIATIVE_NAME

RESULTS

SHOP_SEGMENTS

STORE_ID

USRTRAFFIC_ID

VIEWED

getCampaignLoggingData

sendCampaignLoggingEvent

sendCampaignLoggingEvent

serializeCampaignLoggingData