Package com.adobe.cq.targetrecommendations.api.model

Interface TargetRecommendation

All Superinterfaces:

RecommendationsEntity

@ProviderType
public interface TargetRecommendation
extends RecommendationsEntity

Abstraction of an Adobe Target recommendation

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TargetRecommendation.RecommendationState	Enumeration of the possible states of a Target Recommendations

Method Summary

Modifier and Type	Method	Description
List<Integer>	getAlgorithmIds()	Get the list of algorithms used by this recommendation
int	getCatalogId()	Get the Id of the product catalog used by this recommendation
int	getDefaultContentId()	The default content id for this recommendations
String	getEndDate()	Gets the end date of this recommendation
int	getId()	Uniquely identifies a TargetRecommendation
String	getLocationDisplayMbox()	Gets the name of the MBox where this recommendation is targeted
String	getName()	Get the name of this TargetRecommendation
String	getStartDate()	Gets the start date of this recommendation
TargetRecommendation.RecommendationState	getState()	Get the state of this recommendation
List<String>	getTemplateNames()	Get the list of template names used by this recommendation

Methods inherited from interface com.adobe.cq.targetrecommendations.api.model.RecommendationsEntity

toJson

Method Detail

getId

int getId()

Uniquely identifies a TargetRecommendation

Returns:

a Integer value identifying this TargetRecommendation

getName

String getName()

Get the name of this TargetRecommendation

Returns:

a String object containing this recommendation's name

getCatalogId

int getCatalogId()

Get the Id of the product catalog used by this recommendation

Returns:

a {link Integer} value identifying a product catalog

getTemplateNames

List<String> getTemplateNames()

Get the list of template names used by this recommendation

Returns:

a List containing the template names

getState

TargetRecommendation.RecommendationState getState()

Get the state of this recommendation

Returns:

a RecommendationState enum value with the state of this recommendation

getAlgorithmIds

List<Integer> getAlgorithmIds()

Get the list of algorithms used by this recommendation

Returns:

a List containing the ids of the used algorithms

getLocationDisplayMbox

String getLocationDisplayMbox()

Gets the name of the MBox where this recommendation is targeted

Returns:

a String object containing the MBox name

getDefaultContentId

int getDefaultContentId()

The default content id for this recommendations

Returns:

a non-negative id indicating the default content

getStartDate

String getStartDate()

Gets the start date of this recommendation

Returns:

String containing the recommendation campaign start date

getEndDate

String getEndDate()

Gets the end date of this recommendation

Returns:

String containing the recommendation campaign end date