com.recombee.api_client.api_requests

Class InsertToSeries

java.lang.Object

com.recombee.api_client.api_requests.Request

com.recombee.api_client.api_requests.InsertToSeries

public class InsertToSeries
extends Request

Inserts an existing item/series into series of given seriesId at position determined by time.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	cascadeCreate Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked).
protected java.lang.String	itemId ID of the item iff `itemType` is `item`.
protected java.lang.String	itemType `item` iff the regular item from the catalog is to be inserted, `series` iff series is inserted as the item.
protected java.lang.String	seriesId ID of the series to be inserted into.
protected java.lang.Double	time Time index used for sorting items in the series.

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

timeout

Constructor Summary

Constructors

Constructor and Description
InsertToSeries(java.lang.String seriesId, java.lang.String itemType, java.lang.String itemId, double time) 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	getItemId()
java.lang.String	getItemType()
java.lang.String	getPath()
java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters() Get query parameters
java.lang.String	getSeriesId()
double	getTime()
InsertToSeries	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

seriesId

protected java.lang.String seriesId

ID of the series to be inserted into.

itemType

protected java.lang.String itemType

`item` iff the regular item from the catalog is to be inserted, `series` iff series is inserted as the item.

itemId

protected java.lang.String itemId

ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.

time

protected java.lang.Double time

Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.

cascadeCreate

protected java.lang.Boolean cascadeCreate

Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.

Constructor Detail

InsertToSeries

public InsertToSeries(java.lang.String seriesId,
                      java.lang.String itemType,
                      java.lang.String itemId,
                      double time)

Construct the request

Parameters:

seriesId - ID of the series to be inserted into.

itemType - `item` iff the regular item from the catalog is to be inserted, `series` iff series is inserted as the item.

itemId - ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.

time - Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.

Method Detail

setCascadeCreate

public InsertToSeries setCascadeCreate(boolean cascadeCreate)

Parameters:

cascadeCreate - Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.

getSeriesId

public java.lang.String getSeriesId()

getItemType

public java.lang.String getItemType()

getItemId

public java.lang.String getItemId()

getTime

public double getTime()

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)