oracle.dmt.op.re.reapi.rt
Class RecommendationList

java.lang.Object
oracle.dmt.op.re.reapi.rt.RecommendationList

public class RecommendationList

extends java.lang.Object

Encapsulates a list of recommended items.

Since:

9.0.0

Constructor Summary

RecommendationList(Enum.InterestDimensionType iDim)
Creates a new, empty object of RecommendationList.

Method Summary

void	addElement(Recommendation rec) Adds a recommendation to the list.
Enum.InterestDimensionType	getInterestDimension() Returns the interest dimension used by ratings.
int	getNumberOfRecommendations() Returns the size of recommendation list.
Recommendation	getRecommendation(int index) Returns a recommendation using its index.
java.lang.String	toString() Converts recommendation list to readable text.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecommendationList

public RecommendationList(Enum.InterestDimensionType iDim)
                   throws NullParameterException

Creates a new, empty object of RecommendationList.

Parameters:

iDim - the interest dimension that defines the context of the ratings

Throws:

NullParameterException - if the interest dimension is null

See Also:

Enum.InterestDimensionType

Method Detail

getInterestDimension

public Enum.InterestDimensionType getInterestDimension()

Returns the interest dimension used by ratings.

Returns:

InterestDimensionType

addElement

public void addElement(Recommendation rec)
                throws NullParameterException

Adds a recommendation to the list.

Parameters:

rec - object of class Recommendation

Throws:

NullParameterException - if the input Recommendation object is null

getRecommendation

public Recommendation getRecommendation(int index)

Returns a recommendation using its index.

Parameters:

index - the index of the recommendation, 0-based

Returns:

recommendation object, null if index is out of range

getNumberOfRecommendations

public int getNumberOfRecommendations()

Returns the size of recommendation list.

Returns:

int number of recommendations

toString

public java.lang.String toString()

Converts recommendation list to readable text. Mainly used for debugging purposes.