de.hybris.platform.odata2services.odata.persistence

Interface ModelEntityService

All Known Implementing Classes:

DefaultModelEntityService

public interface ModelEntityService

Service to create or update platform items based on an ODataEntry

Method Summary

Modifier and Type	Method and Description
void	addIntegrationKeyToODataEntry(EdmEntitySet entitySet, ODataEntry oDataEntry) Adds the alias value for an item's integrationKey to the oDataEntry
ItemModel	createOrUpdateItem(StorageRequest request, CreateItemStrategy createItemStrategy) create or update platform items based on an ODataEntry
ODataEntry	getODataEntry(RetrievalRequest request) Converts an itemModel into a ODataEntry
ItemModel	lookup(StorageRequest storageRequest) gets an itemModel based on the given information.

Method Detail

createOrUpdateItem

ItemModel createOrUpdateItem(StorageRequest request,
                             CreateItemStrategy createItemStrategy)
                      throws EdmException

create or update platform items based on an ODataEntry

Parameters:

request - Parameter object that holds values for creating or updating an item.

createItemStrategy - strategy used to create non-existing items

Returns:

the ItemModel that was created or updated

Throws:

EdmException - in case there is an OData related issue

lookup

ItemModel lookup(StorageRequest storageRequest)
          throws EdmException

gets an itemModel based on the given information.

Parameters:

storageRequest - Parameter object that holds values for getting an itemModel

Returns:

the itemModel

Throws:

EdmException - in case there is an OData related issue

getODataEntry

ODataEntry getODataEntry(RetrievalRequest request)
                  throws EdmException

Converts an itemModel into a ODataEntry

Parameters:

request - Parameter object that holds values for getting an ODataEntry

Returns:

The ODataEntry representation

Throws:

EdmException - in case there is an OData related issue

addIntegrationKeyToODataEntry

void addIntegrationKeyToODataEntry(EdmEntitySet entitySet,
                                   ODataEntry oDataEntry)
                            throws EdmException

Adds the alias value for an item's integrationKey to the oDataEntry

Parameters:

entitySet - Edmx representation of the item

oDataEntry - request body represented as xml or json

Throws:

EdmException - in case there is an OData related issue