Interface TargetRecommendation
- All Superinterfaces:
RecommendationsEntity
Abstraction of an Adobe Target recommendation
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumEnumeration of the possible states of a Target Recommendations -
Method Summary
Modifier and TypeMethodDescriptionGet the list of algorithms used by this recommendationintGet the Id of the product catalog used by this recommendationintThe default content id for this recommendationsGets the end date of this recommendationintgetId()Uniquely identifies aTargetRecommendationGets the name of the MBox where this recommendation is targetedgetName()Get the name of thisTargetRecommendationGets the start date of this recommendationgetState()Get the state of this recommendationGet the list of template names used by this recommendationMethods inherited from interface com.adobe.cq.targetrecommendations.api.model.RecommendationsEntity
toJson
-
Method Details
-
getId
int getId()Uniquely identifies aTargetRecommendation- Returns:
- a
Integervalue identifying thisTargetRecommendation
-
getName
String getName()Get the name of thisTargetRecommendation- Returns:
- a
Stringobject 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
Get the list of template names used by this recommendation- Returns:
- a
Listcontaining the template names
-
getState
TargetRecommendation.RecommendationState getState()Get the state of this recommendation- Returns:
- a
RecommendationStateenum value with the state of this recommendation
-
getAlgorithmIds
Get the list of algorithms used by this recommendation- Returns:
- a
Listcontaining the ids of the used algorithms
-
getLocationDisplayMbox
String getLocationDisplayMbox()Gets the name of the MBox where this recommendation is targeted- Returns:
- a
Stringobject 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:
Stringcontaining the recommendation campaign start date
-
getEndDate
String getEndDate()Gets the end date of this recommendation- Returns:
Stringcontaining the recommendation campaign end date
-