com.recombee.api_client.api_requests

Class MergeUsers

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.MergeUsers

public class MergeUsers
extends Request

Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable. Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted**.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	cascadeCreate Sets whether the user *targetUserId* should be created if not present in the database.
protected java.lang.String	sourceUserId ID of the source user.
protected java.lang.String	targetUserId ID of the targer user.

Fields inherited from class com.recombee.api_client.api_requests.Request

timeout

Constructor Summary

Constructors

Constructor and Description
MergeUsers(java.lang.String targetUserId, java.lang.String sourceUserId) Construct the request

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getBodyParameters() Get body parameters
boolean	getCascadeCreate()
HTTPMethod	getHTTPMethod()
java.lang.String	getPath()
java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
java.lang.String	getSourceUserId()
java.lang.String	getTargetUserId()
MergeUsers	setCascadeCreate(boolean cascadeCreate)

Methods inherited from class com.recombee.api_client.api_requests.Request

getEnsureHttps, getTimeout, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

targetUserId

protected java.lang.String targetUserId

ID of the targer user.

sourceUserId

protected java.lang.String sourceUserId

ID of the source user.

cascadeCreate

protected java.lang.Boolean cascadeCreate

Sets whether the user *targetUserId* should be created if not present in the database.

Constructor Detail

MergeUsers

public MergeUsers(java.lang.String targetUserId,
                  java.lang.String sourceUserId)

Construct the request

Parameters:

targetUserId - ID of the targer user.

sourceUserId - ID of the source user.

Method Detail

setCascadeCreate

public MergeUsers setCascadeCreate(boolean cascadeCreate)

Parameters:

cascadeCreate - Sets whether the user *targetUserId* should be created if not present in the database.

getTargetUserId

public java.lang.String getTargetUserId()

getSourceUserId

public java.lang.String getSourceUserId()

getCascadeCreate

public boolean getCascadeCreate()

getHTTPMethod

public HTTPMethod getHTTPMethod()

Specified by:

getHTTPMethod in class Request

Returns:

Used HTTP method

getPath

public java.lang.String getPath()

Specified by:

getPath in class Request

Returns:

URI to the endpoint including path parameters

getQueryParameters

public java.util.Map<java.lang.String,java.lang.Object> getQueryParameters()

Get query parameters

Specified by:

getQueryParameters in class Request

Returns:

Values of query parameters (name of parameter: value of the parameter)

getBodyParameters

public java.util.Map<java.lang.String,java.lang.Object> getBodyParameters()

Get body parameters

Specified by:

getBodyParameters in class Request

Returns:

Values of body parameters (name of parameter: value of the parameter)