com.brein.api

Class BreinifyExecutor

java.lang.Object

com.brein.api.BreinifyExecutor

public class BreinifyExecutor
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BreinifyExecutor()

Method Summary

Modifier and Type	Method and Description
void	activity() Sends an activity to the engine utilizing the API.
void	activity(BreinUser user, java.lang.String activityType, java.lang.String category, java.lang.String description) Sends an activity to the engine utilizing the API.
void	activity(BreinUser user, java.lang.String activityType, java.lang.String category, java.lang.String description, java.util.function.Function<java.lang.String,java.lang.Void> errorCallback) Sends an activity to the engine utilizing the API.
void	applyActivityConfiguration() This is necessary because the configuration from class BreinifyExecutor needs to be transferred to class Breinify in order to invoke the activity and lookup calls within class Breinify.
void	applyRecommendationConfiguration() This is necessary because the configuration from class BreinifyExecutor needs to be transferred to class Breinify in order to invoke the recommendation calls within class Breinify.
void	applyTemporalDataConfiguration() This is necessary because the configuration from class BreinifyExecutor needs to be transferred to class Breinify in order to invoke the temporaldata calls within class Breinify.
BreinActivity	getBreinActivity() Retrieves the instance of the brein activity
BreinLookup	getBreinLookup() Retrieves the instance of the brein lookup
BreinConfig	getConfig() gets the config
BreinResult	lookup(BreinUser user, BreinDimension dimension) Retrieves a lookup result from the engine.
BreinResult	recommendation(BreinUser user, int numberOfRecommendations) Invokes the recommendation request to the engine utilizing the API.
void	setConfig(BreinConfig breinConfig) sets the configuration
void	shutdown() Shutdown Breinify services
BreinResult	temporalData(BreinUser breinUser) Sends a temporalData to the engine utilizing the API.

Methods inherited from class java.lang.Object

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

Constructor Detail

BreinifyExecutor

public BreinifyExecutor()

Method Detail

getConfig

public BreinConfig getConfig()

gets the config

Returns:

config

setConfig

public void setConfig(BreinConfig breinConfig)

sets the configuration

Parameters:

breinConfig - config object

getBreinActivity

public BreinActivity getBreinActivity()

Retrieves the instance of the brein activity

Returns:

breinActivity object

getBreinLookup

public BreinLookup getBreinLookup()

Retrieves the instance of the brein lookup

Returns:

breinLookup object

activity

public void activity(BreinUser user,
                     java.lang.String activityType,
                     java.lang.String category,
                     java.lang.String description,
                     java.util.function.Function<java.lang.String,java.lang.Void> errorCallback)

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is asynchronous.

Parameters:

user - a plain object specifying the user information the activity belongs to

activityType - the type of the activity collected, i.e., one of search, login, logout, addToCart, removeFromCart, checkOut, selectProduct, or other. if not specified, the default other will be used

category - the category of the platform/service/products, i.e., one of apparel, home, education, family, food, health, job, services, or other

description - a string with further information about the activity performed

errorCallback - a callback function that is invoked in case of an error (can be null)

activity

public void activity(BreinUser user,
                     java.lang.String activityType,
                     java.lang.String category,
                     java.lang.String description)

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is asynchronous.

Parameters:

user - a plain object specifying the user information the activity belongs to

activityType - the type of the activity collected, i.e., one of search, login, logout, addToCart, removeFromCart, checkOut, selectProduct, or other. if not specified, the default other will be used

category - the category of the platform/service/products, i.e., one of apparel, home, education, family, food, health, job, services, or other

description - a string with further information about the activity performed

applyActivityConfiguration

public void applyActivityConfiguration()

This is necessary because the configuration from class BreinifyExecutor needs to be transferred to class Breinify in order to invoke the activity and lookup calls within class Breinify.

applyTemporalDataConfiguration

public void applyTemporalDataConfiguration()

This is necessary because the configuration from class BreinifyExecutor needs to be transferred to class Breinify in order to invoke the temporaldata calls within class Breinify.

applyRecommendationConfiguration

public void applyRecommendationConfiguration()

This is necessary because the configuration from class BreinifyExecutor needs to be transferred to class Breinify in order to invoke the recommendation calls within class Breinify.

activity

public void activity()

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is asynchronous.

lookup

public BreinResult lookup(BreinUser user,
                          BreinDimension dimension)

Retrieves a lookup result from the engine. The function needs a valid API-key to be configured to succeed.

This request is synchronous.

Parameters:

user - a plain object specifying information about the user to retrieve data for.

dimension - an object (with an array) containing the names of the dimensions to lookup.

Returns:

response from request wrapped in an object called BreinResponse

temporalData

public BreinResult temporalData(BreinUser breinUser)

Sends a temporalData to the engine utilizing the API. The call is done synchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

Furthermore it uses the internal instance of BreinTemporalData.

Parameters:

breinUser - a plain object specifying information about the user to retrieve data for.

Returns:

result from the Breinify engine

recommendation

public BreinResult recommendation(BreinUser user,
                                  int numberOfRecommendations)

Invokes the recommendation request to the engine utilizing the API. This call is don synchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

Parameters:

user - a plain object specifying the information about the user.

numberOfRecommendations - number of recommendations

Returns:

result from the Breinify engine

shutdown

public void shutdown()

Shutdown Breinify services