com.brein.api

Class BreinRecommendation

java.lang.Object

com.brein.api.BreinBase

com.brein.api.BreinRecommendation

All Implemented Interfaces:

ISecretStrategy

public class BreinRecommendation
extends BreinBase

Constructor Summary

Constructors

Constructor and Description
BreinRecommendation(BreinUser breinUser, int numberOfRecommendations) Ctor with full configuration

Method Summary

Modifier and Type	Method and Description
static BreinRecommendation	clone(BreinRecommendation sourceRecommendation) Used to create a clone of a recommendation.
java.lang.String	createSignature() Generates the signature for the request
java.lang.String	getCategory() get the recommendation category
java.lang.String	getEndPoint() retrieves the configured activity endpoint (e.g.
int	getNumberOfRecommendations() get the number of recommendations
java.lang.String	prepareJsonRequest() prepares the json request
BreinRecommendation	setCategory(java.lang.String category) set the recommendation category
BreinRecommendation	setNumberOfRecommendations(int numberOfRecommendations) set the number of recommendations

Methods inherited from class com.brein.api.BreinBase

cloneBase, getBase, getBreinEngine, getBreinUser, getConfig, getErrorCallback, getGson, getIpAddress, getUnixTimestamp, init, isSign, prepareBaseRequestData, setBase, setBreinUser, setConfig, setErrorCallback, setIpAddress, setUnixTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

BreinRecommendation

public BreinRecommendation(BreinUser breinUser,
                           int numberOfRecommendations)

Ctor with full configuration

Parameters:

breinUser - contains the brein user

numberOfRecommendations - the number of recommendations

Method Detail

getNumberOfRecommendations

public int getNumberOfRecommendations()

get the number of recommendations

Returns:

number

setNumberOfRecommendations

public BreinRecommendation setNumberOfRecommendations(int numberOfRecommendations)

set the number of recommendations

Parameters:

numberOfRecommendations - number of recommendations

Returns:

self

getCategory

public java.lang.String getCategory()

get the recommendation category

Returns:

category

setCategory

public BreinRecommendation setCategory(java.lang.String category)

set the recommendation category

Parameters:

category - contains the category

Returns:

self

getEndPoint

public java.lang.String getEndPoint()

retrieves the configured activity endpoint (e.g. \activity)

Overrides:

getEndPoint in class BreinBase

Returns:

endpoint

prepareJsonRequest

public java.lang.String prepareJsonRequest()

prepares the json request

Overrides:

prepareJsonRequest in class BreinBase

Returns:

json string

clone

public static BreinRecommendation clone(BreinRecommendation sourceRecommendation)

Used to create a clone of a recommendation. This is important in order to prevent concurrency issues.

Parameters:

sourceRecommendation - contains the original recommendation object

Returns:

the clone of the recommendation object

createSignature

public java.lang.String createSignature()

Generates the signature for the request

Specified by:

createSignature in interface ISecretStrategy

Overrides:

createSignature in class BreinBase

Returns:

full signature