Package org.apache.unomi.api.campaigns

Class Campaign

java.lang.Object
org.apache.unomi.api.Item
org.apache.unomi.api.MetadataItem
org.apache.unomi.api.campaigns.Campaign
All Implemented Interfaces:
Serializable
public class Campaign extends MetadataItem
A goal-oriented, time-limited marketing operation that needs to be evaluated for return on investment performance by tracking the ratio of visits to conversions.
See Also:

  • Field Details

  • Constructor Details

    • Campaign

      public Campaign()
      Instantiates a new Campaign.

    • Campaign

      public Campaign(Metadata metadata)
      Instantiates a new Campaign with the specified metadata.
      Parameters:
      metadata - the metadata

  • Method Details

    • getStartDate

      public Date getStartDate()
      Retrieves the start date for this Campaign.
      Returns:
      the start date

    • setStartDate

      public void setStartDate(Date startDate)
      Sets the start date for this Campaign.
      Parameters:
      startDate - the start date

    • getEndDate

      public Date getEndDate()
      Retrieves the end date for this Campaign.
      Returns:
      the end date

    • setEndDate

      public void setEndDate(Date endDate)
      Sets the end date for this Campaign.
      Parameters:
      endDate - the end date

    • getEntryCondition

      public Condition getEntryCondition()
      Retrieves the entry condition that must be satisfied for users to be considered as taking part of this Campaign.
      Returns:
      the entry condition that must be satisfied for users to be considered as taking part of this Campaign

    • setEntryCondition

      public void setEntryCondition(Condition entryCondition)
      Sets the entry condition that must be satisfied for users to be considered as taking part of this Campaign..
      Parameters:
      entryCondition - the entry condition that must be satisfied for users to be considered as taking part of this Campaign

    • getCost

      public Double getCost()
      Retrieves the cost incurred by this Campaign.
      Returns:
      the cost incurred by this Campaign

    • setCost

      public void setCost(Double cost)
      Sets the cost incurred by this Campaign.
      Parameters:
      cost - the cost incurred by this Campaign

    • getCurrency

      public String getCurrency()
      Retrieves the currency associated to the Campaign's cost.
      Returns:
      the currency associated to the Campaign's cost

    • setCurrency

      public void setCurrency(String currency)
      Sets the currency associated to the Campaign's cost.
      Parameters:
      currency - the currency associated to the Campaign's cost

    • getPrimaryGoal

      public String getPrimaryGoal()
      Retrieves the identifier for this Campaign's primary Goal.
      Returns:
      the identifier for this Campaign's primary Goal

    • setPrimaryGoal

      public void setPrimaryGoal(String primaryGoal)
      Sets the identifier for this Campaign's primary Goal.
      Parameters:
      primaryGoal - the identifier for this Campaign's primary Goal

    • getTimezone

      public String getTimezone()
      Retrieves the timezone associated with this Campaign's start and end dates.
      Returns:
      the timezone associated with this Campaign's start and end dates

    • setTimezone

      public void setTimezone(String timezone)
      Sets the timezone associated with this Campaign's start and end dates.
      Parameters:
      timezone - the timezone associated with this Campaign's start and end dates