com.recombee.api_client.api_requests

Class SetValues

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.SetValues

Direct Known Subclasses:

SetItemValues, SetUserValues

public abstract class SetValues
extends Request

Set/update (some) property values of an entity.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	cascadeCreate Sets whether the entity should be created if not present in the database.
protected java.util.Map<java.lang.String,java.lang.Object>	values The values for the individual properties.

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

timeout

Constructor Summary

Constructors

Constructor and Description
SetValues(java.util.Map<java.lang.String,java.lang.Object> values) 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.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
java.util.Map<java.lang.String,java.lang.Object>	getValues()
SetValues	setCascadeCreate(boolean cascadeCreate)

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

getEnsureHttps, getPath, getTimeout, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

values

protected java.util.Map<java.lang.String,java.lang.Object> values

The values for the individual properties. Key in the Map is the name of the property and value is the value to be set Special key "!cascadeCreate" may be used. It indicates that the entity should be created if it does not exist in the database, as if the corresponding PUT method was used. Note the exclamation mark (!) at the beginning of the parameter's name to distinguish it from the property names.

cascadeCreate

protected java.lang.Boolean cascadeCreate

Sets whether the entity should be created if not present in the database.

Constructor Detail

SetValues

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

Construct the request

Parameters:

values - The values for the individual properties. Key in the Map is the name of the property and value is the value to be set.

Method Detail

getValues

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

setCascadeCreate

public SetValues setCascadeCreate(boolean cascadeCreate)

Parameters:

cascadeCreate - Sets whether the entity should be created if not present in the database.

getCascadeCreate

public boolean getCascadeCreate()

getHTTPMethod

public HTTPMethod getHTTPMethod()

Specified by:

getHTTPMethod in class Request

Returns:

Used HTTP method

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)