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

Class StorageRequest

java.lang.Object

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

de.hybris.platform.odata2services.odata.persistence.CrudRequest

de.hybris.platform.odata2services.odata.persistence.StorageRequest

All Implemented Interfaces:

PersistenceContext

public class StorageRequest
extends CrudRequest
implements PersistenceContext

Request which contains an item for persistence.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StorageRequest.StorageRequestBuilder

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

CrudRequest.DataRequestBuilder<T extends CrudRequest.DataRequestBuilder,R extends CrudRequest>

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

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

Method Summary

Modifier and Type	Method	Description
java.util.Locale	getContentLocale()	Indicates the language, in which localized attributes content is provided.
java.util.Optional<ItemModel>	getContextItem()
java.lang.String	getPostPersistHook()
java.lang.String	getPrePersistHook()
PersistenceContext	getReferencedContext(TypeAttributeDescriptor attribute)	Retrieves the persistence context for an item referenced by the specified attribute
java.util.Collection<PersistenceContext>	getReferencedContexts(TypeAttributeDescriptor attribute)	Retrieves the persistence contexts for the items referenced by the specified attribute
PersistenceContext	getRootContext()	Retrieves the top most persistence context
java.util.Optional<PersistenceContext>	getSourceContext()	Retrieves the persistence context that the referenced context was gotten from
boolean	isItemCanBeCreated()	Determines whether a new item model can be created for the context payload.
boolean	isReplaceAttributes()	Indicates the persistence is to replace the item attributes with what's provided in the IntegrationItem.
void	putItem(ItemModel item)
protected void	setContentLocale(java.util.Locale contentLocale)
protected void	setPostPersistHook(java.lang.String postPersistHook)
protected void	setPrePersistHook(java.lang.String prePersistHook)
static StorageRequest.StorageRequestBuilder	storageRequestBuilder()
ItemLookupRequest	toLookupRequest()	Creates an ItemLookupRequest from this StorageRequest

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

getContentType, getIntegrationItem, getIntegrationKey, getODataEntry, getRequestUri, getServiceRoot, setContentType, setIntegrationItem, setIntegrationKey, setODataEntry, setRequestUri, setServiceRoot

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

Methods inherited from interface de.hybris.platform.inboundservices.persistence.PersistenceContext

getIntegrationItem

Method Detail

storageRequestBuilder

public static StorageRequest.StorageRequestBuilder storageRequestBuilder()

getPrePersistHook

public java.lang.String getPrePersistHook()

getPostPersistHook

public java.lang.String getPostPersistHook()

setPostPersistHook

protected void setPostPersistHook(java.lang.String postPersistHook)

setPrePersistHook

protected void setPrePersistHook(java.lang.String prePersistHook)

toLookupRequest

public ItemLookupRequest toLookupRequest()
                                  throws org.apache.olingo.odata2.api.edm.EdmException

Creates an ItemLookupRequest from this StorageRequest

Returns:

the newly constructed ItemLookupRequest

Throws:

org.apache.olingo.odata2.api.edm.EdmException - if encounters an OData problem

getContentLocale

public java.util.Locale getContentLocale()

Description copied from interface: PersistenceContext

Indicates the language, in which localized attributes content is provided.

Specified by:

getContentLocale in interface PersistenceContext

Returns:

Locale or null

setContentLocale

protected void setContentLocale(java.util.Locale contentLocale)

getContextItem

public java.util.Optional<ItemModel> getContextItem()
                                             throws org.apache.olingo.odata2.api.edm.EdmException

Throws:

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

putItem

public void putItem(ItemModel item)
             throws org.apache.olingo.odata2.api.edm.EdmException

Throws:

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

getReferencedContext

public PersistenceContext getReferencedContext(TypeAttributeDescriptor attribute)

Description copied from interface: PersistenceContext

Retrieves the persistence context for an item referenced by the specified attribute

Specified by:

getReferencedContext in interface PersistenceContext

Parameters:

attribute - specifies referenced item

Returns:

the context containing information about the referenced item

getReferencedContexts

public java.util.Collection<PersistenceContext> getReferencedContexts(TypeAttributeDescriptor attribute)

Description copied from interface: PersistenceContext

Retrieves the persistence contexts for the items referenced by the specified attribute

Specified by:

getReferencedContexts in interface PersistenceContext

Parameters:

attribute - specifies referenced items

Returns:

the context containing information about the referenced items

isReplaceAttributes

public boolean isReplaceAttributes()

Description copied from interface: PersistenceContext

Indicates the persistence is to replace the item attributes with what's provided in the IntegrationItem. This is primarily applicable to collections. The default behavior is to append to the collection. With this method being true, the item's collection attribute will be replaced instead of appended.

Specified by:

isReplaceAttributes in interface PersistenceContext

Returns:

true means to replace attributes, otherwise false.

isItemCanBeCreated

public boolean isItemCanBeCreated()

Description copied from interface: PersistenceContext

Determines whether a new item model can be created for the context payload.

Specified by:

isItemCanBeCreated in interface PersistenceContext

Returns:

true, when new item can be create, if an item matching the context was not found in the persistent storage; false, if the context implies update only and therefore the item should not be created, if it does not exist yet.

getSourceContext

public java.util.Optional<PersistenceContext> getSourceContext()

Description copied from interface: PersistenceContext

Retrieves the persistence context that the referenced context was gotten from

Specified by:

getSourceContext in interface PersistenceContext

Returns:

the source context. If the context is already the source, Optional.empty is returned

getRootContext

public PersistenceContext getRootContext()

Description copied from interface: PersistenceContext

Retrieves the top most persistence context

Specified by:

getRootContext in interface PersistenceContext

Returns:

the root context