Package org.apache.unomi.api.campaigns.events

Class CampaignEvent

java.lang.Object

org.apache.unomi.api.Item

org.apache.unomi.api.MetadataItem

org.apache.unomi.api.campaigns.events.CampaignEvent

All Implemented Interfaces:

Serializable

public class CampaignEvent
extends MetadataItem

A specific campaign event to help analyzing your key performance indicators by marking specific dates during your campaign.

Author:

: rincevent Created : 17/03/15

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ITEM_TYPE	The CampaignEvent ITEM_TYPE.

Fields inherited from class org.apache.unomi.api.MetadataItem

metadata

Fields inherited from class org.apache.unomi.api.Item

itemId, itemType, scope, systemMetadata, version

Constructor Summary

Constructors

Constructor	Description
CampaignEvent()	Instantiates a new Campaign event.
CampaignEvent(Metadata metadata)	Instantiates a new Campaign event with the specified metadata.

Method Summary

Modifier and Type	Method	Description
String	getCampaignId()	Retrieves the identifier of the associated Campaign.
Double	getCost()	Retrieves the cost associated with this campaign event.
String	getCurrency()	Retrieves the currency.
Date	getEventDate()	Retrieves the event date.
String	getTimezone()	Retrieves the timezone.
void	setCampaignId(String campaignId)	Sets the campaign id.
void	setCost(Double cost)	Sets the cost.
void	setCurrency(String currency)	Sets the currency.
void	setEventDate(Date eventDate)	Sets the event date.
void	setTimezone(String timezone)	Sets the timezone.

Methods inherited from class org.apache.unomi.api.MetadataItem

getMetadata, getScope, setMetadata

Methods inherited from class org.apache.unomi.api.Item

equals, getItemId, getItemType, getItemType, getSystemMetadata, getVersion, hashCode, setItemId, setItemType, setScope, setSystemMetadata, setVersion

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ITEM_TYPE

public static final String ITEM_TYPE

The CampaignEvent ITEM_TYPE.

See Also:

• for a discussion of ITEM_TYPE
• Constant Field Values

Constructor Details

CampaignEvent

public CampaignEvent()

Instantiates a new Campaign event.

CampaignEvent

public CampaignEvent(Metadata metadata)

Instantiates a new Campaign event with the specified metadata.

Parameters:

metadata - the metadata

Method Details

getCost

public Double getCost()

Retrieves the cost associated with this campaign event.

Returns:

the cost associated with this campaign event

setCost

public void setCost(Double cost)

Sets the cost.

Parameters:

cost - the cost

getCurrency

public String getCurrency()

Retrieves the currency.

Returns:

the currency

setCurrency

public void setCurrency(String currency)

Sets the currency.

Parameters:

currency - the currency

getEventDate

public Date getEventDate()

Retrieves the event date.

Returns:

the event date

setEventDate

public void setEventDate(Date eventDate)

Sets the event date.

Parameters:

eventDate - the event date

getCampaignId

public String getCampaignId()

Retrieves the identifier of the associated Campaign.

Returns:

the identifier of the associated Campaign

setCampaignId

public void setCampaignId(String campaignId)

Sets the campaign id.

Parameters:

campaignId - the campaign id

getTimezone

public String getTimezone()

Retrieves the timezone.

Returns:

the timezone

setTimezone

public void setTimezone(String timezone)

Sets the timezone.

Parameters:

timezone - the timezone