Package de.hybris.platform.odata2services.odata.persistence

Class ItemConversionRequest

java.lang.Object

de.hybris.platform.odata2services.odata.persistence.AbstractRequest

de.hybris.platform.odata2services.odata.persistence.ItemConversionRequest

public class ItemConversionRequest
extends AbstractRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ItemConversionRequest.ItemConversionRequestBuilder

Nested classes/interfaces inherited from class de.hybris.platform.odata2services.odata.persistence.AbstractRequest

AbstractRequest.AbstractRequestBuilder<T extends AbstractRequest.AbstractRequestBuilder,R extends AbstractRequest>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ItemConversionRequest()

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getAllPropertyNames()
int	getConversionLevel()	Determines how deep the item being converted by this request is located in the object graph.
ItemModel	getItemModel()	Deprecated, for removal: This API element is subject to removal in a future version. use getValue().
ConversionOptions	getOptions()
java.lang.Object	getValue()
boolean	isPropertyValueShouldBeConverted(java.lang.String property)	Determines whether the specified property value should be subsequently converted to an ODataEntry or not.
static ItemConversionRequest.ItemConversionRequestBuilder	itemConversionRequestBuilder()
ItemConversionRequest	propertyConversionRequest(java.lang.String propertyName, ItemModel item)	Deprecated, for removal: This API element is subject to removal in a future version. use propertyConversionRequest(String, Object)
ItemConversionRequest	propertyConversionRequest(java.lang.String propertyName, java.lang.Object value)
protected void	setItemModel(ItemModel itemModel)	Deprecated, for removal: This API element is subject to removal in a future version. use setValue(Object)
protected void	setOptions(ConversionOptions options)
protected void	setValue(java.lang.Object value)

Methods inherited from class de.hybris.platform.odata2services.odata.persistence.AbstractRequest

getAcceptLocale, getEntitySet, getEntitySetReferencedByProperty, getEntityType, getIntegrationObjectCode, getPropertyTypeName, setAcceptLocale, setEntitySet, setEntityType, setIntegrationObjectCode

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemConversionRequest

protected ItemConversionRequest()

Method Detail

itemConversionRequestBuilder

public static ItemConversionRequest.ItemConversionRequestBuilder itemConversionRequestBuilder()

getItemModel

@Deprecated(since="1905.09-CEP",
            forRemoval=true)
public ItemModel getItemModel()

Deprecated, for removal: This API element is subject to removal in a future version.

use getValue(). If item model was passed to setValue(Object) method, this method will return the set value; otherwise this method returns null and getValue() returns the set value.

getValue

public java.lang.Object getValue()

getOptions

public ConversionOptions getOptions()

setItemModel

@Deprecated(since="1905.09-CEP",
            forRemoval=true)
protected void setItemModel(ItemModel itemModel)

Deprecated, for removal: This API element is subject to removal in a future version.

use setValue(Object)

setValue

protected void setValue(java.lang.Object value)

setOptions

protected void setOptions(ConversionOptions options)

propertyConversionRequest

@Deprecated(since="1905.09-CEP",
            forRemoval=true)
public ItemConversionRequest propertyConversionRequest(java.lang.String propertyName,
                                                       ItemModel item)
                                                throws org.apache.olingo.odata2.api.edm.EdmException

Deprecated, for removal: This API element is subject to removal in a future version.

use propertyConversionRequest(String, Object)

Throws:

org.apache.olingo.odata2.api.edm.EdmException

propertyConversionRequest

public ItemConversionRequest propertyConversionRequest(java.lang.String propertyName,
                                                       java.lang.Object value)
                                                throws org.apache.olingo.odata2.api.edm.EdmException

Throws:

org.apache.olingo.odata2.api.edm.EdmException

getConversionLevel

public int getConversionLevel()

Determines how deep the item being converted by this request is located in the object graph. Every time propertyConversionRequest(String, Object) is called it increases the conversion level (the distance of the resulting request from the very original conversion request).

Returns:

number of times propertyConversionRequest(String, Object) was called from the original request to get this request or 0, if this request is the original request. For example, if an item Product has property "catalog", which refers to Catalog item, then conversion request for Product item will have conversion level 0, conversion request for Catalog item will have conversion level 1, and so on for any subsequent item referenced from the Catalog.

isPropertyValueShouldBeConverted

public boolean isPropertyValueShouldBeConverted(java.lang.String property)

Determines whether the specified property value should be subsequently converted to an ODataEntry or not.

Parameters:

property - name of the item property

Returns:

true, if the property is a key property or it is next segment in the navigation/expand path specified for the request; false, otherwise.

getAllPropertyNames

public java.util.List<java.lang.String> getAllPropertyNames()
                                                     throws org.apache.olingo.odata2.api.edm.EdmException

Throws:

org.apache.olingo.odata2.api.edm.EdmException