de.hybris.platform.campaigns.service

Interface CampaignService

All Known Implementing Classes:

DefaultCampaignService

public interface CampaignService

The interface for managing campaigns

Method Summary

Modifier and Type	Method and Description
java.util.List<CampaignModel>	getActiveCampaigns() Provides list of all active campaigns.
java.util.List<CampaignModel>	getAllCampaigns() Provides list of all campaigns.
CampaignModel	getCampaignByCode(java.lang.String code) Provides CampaignModel with requested CampaignModel.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 has CampaignModel.ENABLED eq true and the current time provided by TimeService API is between CampaignModel.STARTDATE and CampaignModel.ENDDATE inclusive. When the value of CampaignModel.STARTDATE or CampaignModel.ENDDATE is not set then this value is considered as within date range.

Returns:

list of active CampaignModels.

getCampaignByCode

CampaignModel getCampaignByCode(java.lang.String code)

Provides CampaignModel with requested CampaignModel.CODE

Parameters:

code - code of campaign

Returns:

matching CampaignModel

Throws:

UnknownIdentifierException - if campaign with given code hasn't been found

AmbiguousIdentifierException - if there are more than one campaign using the same code