Interface CampaignService
-
- All Known Implementing Classes:
DefaultCampaignService
public interface CampaignServiceThe interface for managing campaigns
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<CampaignModel>getActiveCampaigns()Provides list of all active campaigns.java.util.List<CampaignModel>getAllCampaigns()Provides list of all campaigns.CampaignModelgetCampaignByCode(java.lang.String code)ProvidesCampaignModelwith requestedCampaignModel.CODE
-
-
-
Method Detail
-
getAllCampaigns
java.util.List<CampaignModel> getAllCampaigns()
Provides list of all campaigns.- Returns:
- list of all
CampaignModels.
-
getActiveCampaigns
java.util.List<CampaignModel> getActiveCampaigns()
Provides list of all active campaigns. Campaign is considered as active when it hasCampaignModel.ENABLEDeq true and the current time provided byTimeServiceAPI is betweenCampaignModel.STARTDATEandCampaignModel.ENDDATEinclusive. When the value ofCampaignModel.STARTDATEorCampaignModel.ENDDATEis not set then this value is considered as within date range.- Returns:
- list of active
CampaignModels.
-
getCampaignByCode
CampaignModel getCampaignByCode(java.lang.String code)
ProvidesCampaignModelwith requestedCampaignModel.CODE- Parameters:
code- code of campaign- Returns:
- matching
CampaignModel - Throws:
UnknownIdentifierException- if campaign with given code hasn't been foundAmbiguousIdentifierException- if there are more than one campaign using the same code
-
-