tools.gsf.facade.runtag.commercecontext

Class GetRecommendations

java.lang.Object

tools.gsf.facade.FTValListFacade

tools.gsf.facade.runtag.AbstractTagRunner

tools.gsf.facade.runtag.commercecontext.GetRecommendations

All Implemented Interfaces:

TagRunner

public final class GetRecommendations
extends AbstractTagRunner

Retrieves and lists the assets that match the recommendation constraints passed to the tag.

Syntax

<COMMERCECONTEXT.GETRECOMMENDATION COLLECTION="recommendationname" [LIST="inputlist"] [VALUE="rating"] [MAXCOUNT="assetcount"] LISTVARNAME="assetlist" [FILTER="true|false"]/>

This tag returns a list containing up to the specified number of recommended assets. The recommendations, and the returned order of them, are based on the details of the referenced recommendation asset. This tag automatically calculates segment affinity and promotion affinity for the current visitor, if they have not yet been calculated. For information about creating recommendations, including context-based recommendations, see the CS Developer's Guide.

NOTE: This tag also causes compositional dependencies to be recorded for all assets that contribute to the returned lists, and may, under the right conditions, have the same effect as a RENDER.UNKNOWNDEPS tag.

Since:

Apr 12, 2010

Author:

Tony Field

Field Summary

Fields inherited from class tools.gsf.facade.FTValListFacade

list

Constructor Summary

Constructors

Constructor and Description
GetRecommendations()

Method Summary

Modifier and Type	Method and Description
static COM.FutureTense.Interfaces.IList	getRecommendations(COM.FutureTense.Interfaces.ICS ics, long recId, int max) Deprecated. replaced by Recommendations.getRecommendations(ICS, String, int).
void	setCollection(String collection)
void	setCollectionId(long collectionid)
void	setCollectionId(String collectionid)
void	setFilter(boolean filter)
void	setList(String inputList)
void	setListVarName(String assetlist)
void	setMaxCount(int assetcount)
void	setValue(int rating)

Methods inherited from class tools.gsf.facade.runtag.AbstractTagRunner

bind, execute, handleError, postExecute, preExecute

Methods inherited from class tools.gsf.facade.FTValListFacade

getList, set, set, set, set, set, set

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetRecommendations

public GetRecommendations()

Method Detail

setCollection

public void setCollection(String collection)

Parameters:

collection - Input parameter. Name of the recommendation. The sort and selection criteria defined in the recommendation are used to create the list of possible assets. You can constrain this list by using the MAXCOUNT argument, defined below. If there are any promotions in place that override this recommendation, it substitutes the name of the promotion, instead.

setCollectionId

public void setCollectionId(String collectionid)

Parameters:

collectionid - ID of the recommendation. The sort and selection criteria defined in the recommendation are used to create the list of possible assets. You can constrain this list by using the MAXCOUNT argument, defined below. If there are any promotions in place that override this recommendation, it substitutes the name of the promotion, instead.

setCollectionId

public void setCollectionId(long collectionid)

Parameters:

collectionid - ID of the recommendation. The sort and selection criteria defined in the recommendation are used to create the list of possible assets. You can constrain this list by using the MAXCOUNT argument, defined below. If there are any promotions in place that override this recommendation, it substitutes the name of the promotion, instead.

setList

public void setList(String inputList)

Parameters:

inputList - Input parameter. name of the list of assets you want to be used as the input for the calculation. This argument is applicable only if the recommendation named by COLLECTION is a context-based recommendation. Columns are assettype and assetid.

setValue

public void setValue(int rating)

Parameters:

rating - Input parameter. Default rating for assets that do not have one. If you do not declare a value, unrated assets are assigned a default rating of 50 on a scale of 1-100.

setMaxCount

public void setMaxCount(int assetcount)

Parameters:

assetcount - Input parameter. Maximum number of assets to return. Use this value to constrain the list of recommended assets.

setListVarName

public void setListVarName(String assetlist)

Parameters:

assetlist - Input and output parameter. As input, name you want to assign to the list of assets returned on output. Its columns are: assettype and assetid.

setFilter

public void setFilter(boolean filter)

Parameters:

filter - Input parameter. A Boolean value: true specifies that no assets in the input list can be returned as output; false (default) allows input assets to be returned as output.

getRecommendations

@Deprecated
public static COM.FutureTense.Interfaces.IList getRecommendations(COM.FutureTense.Interfaces.ICS ics,
                                                                              long recId,
                                                                              int max)

Deprecated. replaced by Recommendations.getRecommendations(ICS, String, int).

Easy-to-use utility method to return recommendations for the specified asset.

Parameters:

ics - context

recId - id of recommendation to return

max - max count

Returns:

IList containing recommendations

See Also:

IterableIListWrapper