com.ibm.commerce.marketing.commands.ranking

Class Ranking

java.lang.Object

com.ibm.commerce.marketing.commands.ranking.Ranking

public class Ranking
extends java.lang.Object

This class represents the definition of how to create a ranking list. It contains all the ranking parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static int	DEFAULT_INTERVAL_TIME The default ranking interval.
static java.lang.String	DEFAULT_RANKING_SIZE The default ranking size.
static java.lang.String	PARAM_OBJECT_TYPE Constant for the ranking parameter object type.
static java.lang.Short	RANKING_TYPE_MOST_BROWSED Predefined object type which will order product by browsed count.
static java.lang.Short	RANKING_TYPE_MOST_SOLD Predefined ranking type which will order product by sold quantity.
static java.lang.String	STATISTICS_TABLENAME Constant for the ranking statistics tablename.

Constructor Summary

Constructors

Constructor and Description
Ranking(java.lang.String newRankingId, java.lang.String newRankingPolicyId, java.util.List newGroupIdList, boolean newIncludeSubCategories, java.lang.String newInterval, java.lang.String newRankingSize, java.lang.String newStoreId) This method creates a ranking definition object.

Method Summary

Modifier and Type	Method and Description
java.util.List	getGroupIdList() This method returns the identifiers of the groups to which the ranking objects will belong.
boolean	getIncludeSubCategories() This method returns the setting if ranking lists should be generated for all the sub categories of the selected categories in the group ID list.
java.lang.String	getInterval() This method returns the interval of grouping the statistics.
java.util.Date	getLastPublish() This method gets the date the ranking list was last published.
java.util.Map	getParamValueMap() This method gets the map that contains all the element name-value pairs that define how to create the ranking list.
java.lang.String	getRankingId() This method returns the ranking identifier.
java.lang.String	getRankingPolicyId() This method returns the ranking policy identifier.
java.lang.String	getRankingSize() This method returns the size of the ranking list.
java.lang.String	getStoreId() This method returns the store identifier.
void	setLastPublish(java.util.Date newLastPublish) This method sets the date the ranking list was last published.
void	setParamValueMap(java.util.Map newParamValueMap) This method sets the map that contains all the element name-value pairs that define how to create the ranking list.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

PARAM_OBJECT_TYPE

public static final java.lang.String PARAM_OBJECT_TYPE

Constant for the ranking parameter object type.

See Also:

Constant Field Values

STATISTICS_TABLENAME

public static final java.lang.String STATISTICS_TABLENAME

Constant for the ranking statistics tablename.

See Also:

Constant Field Values

RANKING_TYPE_MOST_SOLD

public static final java.lang.Short RANKING_TYPE_MOST_SOLD

Predefined ranking type which will order product by sold quantity. This maps to the campaign element template "ranking_MostSold".

RANKING_TYPE_MOST_BROWSED

public static final java.lang.Short RANKING_TYPE_MOST_BROWSED

Predefined object type which will order product by browsed count. This maps to the campaign element template "ranking_MostBrowsed".

DEFAULT_RANKING_SIZE

public static final java.lang.String DEFAULT_RANKING_SIZE

The default ranking size.

See Also:

Constant Field Values

DEFAULT_INTERVAL_TIME

public static final int DEFAULT_INTERVAL_TIME

The default ranking interval.

See Also:

Constant Field Values

Constructor Detail

Ranking

public Ranking(java.lang.String newRankingId,
               java.lang.String newRankingPolicyId,
               java.util.List newGroupIdList,
               boolean newIncludeSubCategories,
               java.lang.String newInterval,
               java.lang.String newRankingSize,
               java.lang.String newStoreId)

This method creates a ranking definition object.

Parameters:

newRankingId - The ranking identifier.

newRankingPolicyId - The ranking policy identifier.

newGroupIdList - The identifier of the group to which the ranking objects will belong.

newIncludeSubCategories - Should the ranking list be generated for every subcategory.

newInterval - The interval of grouping the statistics.

newRankingSize - The size of the ranking list.

newStoreId - The store identifier.

Method Detail

getInterval

public java.lang.String getInterval()

This method returns the interval of grouping the statistics.

Returns:

Returns the interval of grouping the statistics.

getGroupIdList

public java.util.List getGroupIdList()

This method returns the identifiers of the groups to which the ranking objects will belong.

Returns:

Returns the identifiers of the groups to which the ranking objects will belong.

getIncludeSubCategories

public boolean getIncludeSubCategories()

This method returns the setting if ranking lists should be generated for all the sub categories of the selected categories in the group ID list.

Returns:

This method returns true if ranking lists should be generated for all sub categories.

getRankingId

public java.lang.String getRankingId()

This method returns the ranking identifier.

Returns:

Returns the ranking identifier.

getRankingPolicyId

public java.lang.String getRankingPolicyId()

This method returns the ranking policy identifier.

Returns:

Returns the ranking policy identifier.

getStoreId

public java.lang.String getStoreId()

This method returns the store identifier.

Returns:

Returns the store identifier.

getRankingSize

public java.lang.String getRankingSize()

This method returns the size of the ranking list.

Returns:

Returns the size of the ranking list.

getLastPublish

public java.util.Date getLastPublish()

This method gets the date the ranking list was last published.

Returns:

Returns the date the ranking list was last published.

setLastPublish

public void setLastPublish(java.util.Date newLastPublish)

This method sets the date the ranking list was last published.

Parameters:

newLastPublish - The date the ranking list was last published.

getParamValueMap

public java.util.Map getParamValueMap()

This method gets the map that contains all the element name-value pairs that define how to create the ranking list.

Returns:

Returns the map of element name-value pairs.

setParamValueMap

public void setParamValueMap(java.util.Map newParamValueMap)

This method sets the map that contains all the element name-value pairs that define how to create the ranking list.

Parameters:

newParamValueMap - The map of element name-value pairs.