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
java.lang.String	addIntegrationKeyToODataEntry(EdmEntitySet entitySet, ODataEntry oDataEntry) Adds the alias value for an item's integrationKey to the oDataEntry
int	count(ItemLookupRequest lookupRequest) Counts how many items in the platform match the provided request conditions.
ItemModel	createOrUpdateItem(StorageRequest request, CreateItemStrategy createItemStrategy) create or update platform items based on an ODataEntry
ODataEntry	getODataEntry(ItemConversionRequest conversionRequest) Converts an itemModel into a ODataEntry
ItemModel	lookup(ItemLookupRequest lookupRequest) gets an itemModel based on the given information.
ItemLookupResult<ItemModel>	lookupItems(ItemLookupRequest lookupRequest) Searches for item models matching the conditions in the specified request.

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(ItemLookupRequest lookupRequest)
          throws EdmException

gets an itemModel based on the given information.

Parameters:

lookupRequest - Parameter object that holds values for getting an itemModel

Returns:

the itemModel

Throws:

EdmException - in case there is an OData related issue

lookupItems

ItemLookupResult<ItemModel> lookupItems(ItemLookupRequest lookupRequest)
                                 throws EdmException

Searches for item models matching the conditions in the specified request.

Parameters:

lookupRequest - Parameter object that holds values for getting an itemModel

Returns:

result searching item models by the specified request

Throws:

EdmException - in case there is an OData related issue

getODataEntry

ODataEntry getODataEntry(ItemConversionRequest conversionRequest)
                  throws EdmException

Converts an itemModel into a ODataEntry

Parameters:

conversionRequest - Parameter object that holds values for getting an ODataEntry

Returns:

The ODataEntry representation

Throws:

EdmException - in case there is an OData related issue

addIntegrationKeyToODataEntry

java.lang.String addIntegrationKeyToODataEntry(EdmEntitySet entitySet,
                                               ODataEntry oDataEntry)

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

Returns:

The calculated integration key.

count

int count(ItemLookupRequest lookupRequest)
   throws EdmException

Counts how many items in the platform match the provided request conditions.

Parameters:

lookupRequest - a request specifying an item type, at a minimum, and possibly other conditions. For example, the request may point to the objects nested in the request's base item type and referred by the navigation segments.

Returns:

number of items in the platform matching the request conditions.

Throws:

EdmException - in case there is an OData related issue