com.brein.api

Class BreinRecommendation

java.lang.Object

com.brein.api.BreinBase<BreinRecommendation>

com.brein.api.BreinRecommendation

All Implemented Interfaces:

IExecutable<BreinResult>, ISecretStrategy

public class BreinRecommendation
extends BreinBase<BreinRecommendation>
implements IExecutable<BreinResult>

Nested Class Summary

Nested classes/interfaces inherited from class com.brein.api.BreinBase

BreinBase.BaseField

Field Summary

Fields inherited from class com.brein.api.BreinBase

API_KEY_FIELD, GSON, SIGNATURE_FIELD, SIGNATURE_TYPE_FIELD, UNIX_TIMESTAMP_FIELD

Constructor Summary

Constructors

Constructor and Description
BreinRecommendation()

Method Summary

Modifier and Type	Method and Description
java.lang.String	createSignature(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) Generates the signature for the request
BreinResult	execute() Method to execute the request synchronous.
java.lang.String	getCategory() get the recommendation category
java.lang.String	getEndPoint(BreinConfig config) Gets the endpoint to be used to send the request to
int	getNumberOfRecommendations() get the number of recommendations
void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) This method adds the request specific information to the requestData.
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

getBaseField, getGson, getThis, getUnixTimestamp, getUser, prepareRequestData, set, setAdditional, setClientIpAddress, setUnixTimestamp, setUser, setUser, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BreinRecommendation

public BreinRecommendation()

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(BreinConfig config)

Description copied from class: BreinBase

Gets the endpoint to be used to send the request to

Specified by:

getEndPoint in class BreinBase<BreinRecommendation>

Parameters:

config - the current configuration

Returns:

the endpoint to be used to send the request to

See Also:

BreinConfig

prepareRequestData

public void prepareRequestData(BreinConfig config,
                               java.util.Map<java.lang.String,java.lang.Object> requestData)

Description copied from class: BreinBase

This method adds the request specific information to the requestData. It is called by BreinBase.prepareRequestData(BreinConfig) after the request data of the base information is added.

Specified by:

prepareRequestData in class BreinBase<BreinRecommendation>

requestData - the request data to be sent to the endpoint

createSignature

public java.lang.String createSignature(BreinConfig config,
                                        java.util.Map<java.lang.String,java.lang.Object> requestData)

Generates the signature for the request

Specified by:

createSignature in interface ISecretStrategy

Parameters:

config - the configuration

requestData - the data used for the request including all the data that will be sent, without the signature

Returns:

full signature

execute

public BreinResult execute()

Description copied from interface: IExecutable

Method to execute the request synchronous.

Specified by:

execute in interface IExecutable<BreinResult>

Returns:

the returned value