Package de.hybris.platform.odata2services.converter

Interface ODataEntryToIntegrationItemConverter

All Known Implementing Classes:

DefaultODataEntryToIntegrationItemConverter

public interface ODataEntryToIntegrationItemConverter

Converts an ODataEntry to an instance of IntegrationItem

Method Summary

Modifier and Type	Method	Description
IntegrationItem	convert(org.apache.olingo.odata2.api.processor.ODataContext context, TypeDescriptor typeDesc, org.apache.olingo.odata2.api.edm.EdmEntitySet entitySet, org.apache.olingo.odata2.api.ep.entry.ODataEntry entry)	Deprecated, for removal: This API element is subject to removal in a future version. use convert(ODataContext, TypeDescriptor, ODataEntry)
IntegrationItem	convert(org.apache.olingo.odata2.api.processor.ODataContext context, TypeDescriptor typeDesc, org.apache.olingo.odata2.api.ep.entry.ODataEntry entry)	Performs the conversion when TypeDescriptor for the integration item to create is available.
IntegrationItem	convert(org.apache.olingo.odata2.api.processor.ODataContext context, TypeDescriptor typeDesc, org.apache.olingo.odata2.api.ep.entry.ODataEntry entry, IntegrationItem parentItem)	Performs conversion of an OData entry nested in the payload of an outer entry.
IntegrationItem	convert(org.apache.olingo.odata2.api.processor.ODataContext context, org.apache.olingo.odata2.api.edm.EdmEntitySet entitySet, org.apache.olingo.odata2.api.ep.entry.ODataEntry entry)	Performs the conversion when there is no TypeDescriptor available.

Method Detail

convert

IntegrationItem convert(org.apache.olingo.odata2.api.processor.ODataContext context,
                        org.apache.olingo.odata2.api.edm.EdmEntitySet entitySet,
                        org.apache.olingo.odata2.api.ep.entry.ODataEntry entry)
                 throws org.apache.olingo.odata2.api.edm.EdmException

Performs the conversion when there is no TypeDescriptor available. In this case the type descriptor will be derived from the other parameters.

Parameters:

context - context of the request containing the entry

entitySet - metadata about the entry received

entry - the entry received to be converted to the IntegrationItem

Returns:

an integration item converted from the entry

Throws:

org.apache.olingo.odata2.api.edm.EdmException - if there is a problem with the metadata provided by the entitySet

convert

@Deprecated(since="19.05.2004-CEP",
            forRemoval=true)
IntegrationItem convert(org.apache.olingo.odata2.api.processor.ODataContext context,
                        TypeDescriptor typeDesc,
                        org.apache.olingo.odata2.api.edm.EdmEntitySet entitySet,
                        org.apache.olingo.odata2.api.ep.entry.ODataEntry entry)
                 throws org.apache.olingo.odata2.api.edm.EdmException

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

use convert(ODataContext, TypeDescriptor, ODataEntry)

Performs the conversion when TypeDescriptor for the integration item to create is available.

Parameters:

context - context of the request containing the entry

typeDesc - type descriptor for the integration item to create

entitySet - metadata about the entry received

entry - the entry received to be converted to the IntegrationItem

Returns:

an integration item converted from the entry

Throws:

org.apache.olingo.odata2.api.edm.EdmException - if there is a problem with the metadata provided by the entitySet

convert

IntegrationItem convert(org.apache.olingo.odata2.api.processor.ODataContext context,
                        TypeDescriptor typeDesc,
                        org.apache.olingo.odata2.api.ep.entry.ODataEntry entry)

Performs the conversion when TypeDescriptor for the integration item to create is available.

Parameters:

context - context of the request containing the entry

typeDesc - type descriptor for the integration item to create

entry - the entry received to be converted to the IntegrationItem

Returns:

an integration item converted from the entry

convert

IntegrationItem convert(org.apache.olingo.odata2.api.processor.ODataContext context,
                        TypeDescriptor typeDesc,
                        org.apache.olingo.odata2.api.ep.entry.ODataEntry entry,
                        IntegrationItem parentItem)

Performs conversion of an OData entry nested in the payload of an outer entry.

Parameters:

context - context of the request containing the entry

typeDesc - type descriptor for the integration item to create, that matches the entry being converted

entry - the entry received to be converted to the IntegrationItem

parentItem - integration item that corresponds to the OData entry containing the entry being converted.

Returns:

an integration item converted from the entry