com.recombee.api_client.api_requests.SetItemValues Maven / Gradle / Ivy

Go to download
package com.recombee.api_client.api_requests;

import java.util.Map;

import java.util.HashMap;

import com.recombee.api_client.util.HTTPMethod;

/**
 * Set/update (some) property values of a given item. The properties (columns) must be previously created by [Add item property](https://docs.recombee.com/api.html#add-item-property).
 */
public class SetItemValues extends SetValues {

    /**
     * ID of the item which will be modified.
     */
    protected String itemId;

    /**
     * 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 item of the given itemId 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 item property names.
     */
    protected Map values;

    /**
     * Construct the request
     * @param itemId ID of the item which will be modified.
     * @param 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.
     */
    public SetItemValues (String itemId, Map values) {
        super(values);
        this.itemId = itemId;
    }

    public String getItemId() {
         return this.itemId;
    }

    /**
     * @param cascadeCreate Sets whether the entity should be created if not present in the database.
     */
    @Override
    public SetItemValues setCascadeCreate(boolean cascadeCreate) {
         this.cascadeCreate = cascadeCreate;
         return this;
    }

    /**
     * @return URI to the endpoint including path parameters
     */
    @Override
    public String getPath() {
        return String.format("/items/%s", this.itemId);
    }
}