Package de.hybris.platform.campaigns.dao

Interface CampaignDao

All Superinterfaces:

GenericDao<CampaignModel>

All Known Implementing Classes:

DefaultCampaignDao

public interface CampaignDao
extends GenericDao<CampaignModel>

Interface allows searching for CampaignModel

Method Summary

Modifier and Type	Method	Description
java.util.List<CampaignModel>	findActiveCampaigns(java.util.Date currentDateTime)	Provides list of all active campaigns.
java.util.List<CampaignModel>	findAllCampaigns()	Provides list of all campaigns.
CampaignModel	findCampaignByCode(java.lang.String code)	Provides CampaignModel with requested CampaignModel.CODE

Methods inherited from interface de.hybris.platform.servicelayer.internal.dao.GenericDao

find, find, find, find, find

Method Detail

findAllCampaigns

java.util.List<CampaignModel> findAllCampaigns()

Provides list of all campaigns.

Returns:

list of all CampaignModels.

findActiveCampaigns

java.util.List<CampaignModel> findActiveCampaigns(java.util.Date currentDateTime)

Provides list of all active campaigns. Campaign is considered as active when it has CampaignModel.ENABLED eq true and the currentDateTime provided as a parameter 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.

Parameters:

currentDateTime - - Current date time that is used to get active campaign for

Returns:

list of active CampaignModels.

findCampaignByCode

CampaignModel findCampaignByCode(java.lang.String code)

Provides CampaignModel with requested CampaignModel.CODE

Parameters:

code -

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