Interface CampaignService
- All Known Implementing Classes:
DefaultCampaignService
public interface CampaignService
The interface for managing campaigns
-
Method Summary
Modifier and TypeMethodDescriptionProvides list of all active campaigns.Provides list of all campaigns.getCampaignByCode(String code) ProvidesCampaignModelwith requestedCampaignModel.CODE
-
Method Details
-
getAllCampaigns
List<CampaignModel> getAllCampaigns()Provides list of all campaigns.- Returns:
- list of all
CampaignModels.
-
getActiveCampaigns
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
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
-