EntityHandler (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.EntityHandler

Direct Known Subclasses:

DefaultEntityHandler
```
public abstract class EntityHandler
extends java.lang.Object
```
Handler interface for CRUD (create/read/update/delete) operations on entities.

Constructor Summary

Constructors
Constructor and Description

EntityHandler()

Constructors
Constructor and Description
`EntityHandler()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`allowUnused(java.lang.Object value)` Helper function so generated subclasses can explicitly ignore a value.
`abstract void`	`createEntity(EntityValue entity)` Handles the creation of an entity.
`abstract void`	`createLink(EntityValue source, Property sourceProperty, EntityValue target)` Handles the creation of a link.
`abstract void`	`createMedia(EntityValue entity, ByteStream stream)` Handles the creation of a media entity.
`abstract void`	`deleteEntity(EntityValue entity)` Handles the deletion of an entity.
`abstract void`	`deleteLink(EntityValue source, Property sourceProperty, EntityValue target)` Handles the deletion of a link.
`abstract void`	`deleteStream(EntityValue entity, StreamLink link)` Handles the deletion of a stream property.
`abstract void`	`downloadMedia(EntityValue entity, ByteStream stream)` Handles the downloading of a media entity.
`abstract void`	`downloadStream(EntityValue entity, StreamLink link, ByteStream stream)` Handles the downloading of a stream property.
`abstract DataValue`	`executeQuery(DataQuery query)` Handles the execution of a query.
`abstract java.lang.String`	`getNameForMetrics()` Return component name for data metrics.
`abstract boolean`	`isBackendHandler()` Return does this entity handler delegate to a backend system (as opposed to the main service database).
`DataValue`	`loadAll(DataQuery query)` Retrieve all entities (that are to be cached) from the backend system.
`DataValue`	`loadPartition(DataQuery query, EntityValue partition)` Retrieve all entities for a particular partition (that are to be cached) from the backend system.
`abstract void`	`refreshAfter(EntityHandler priorHandler, EntitySet priorEntitySet, EntitySet entitySet)` Register the cache refresh of an entity set to be scheduled after the refresh of a prior entity set.
`abstract void`	`refreshCache(EntitySet entitySet, boolean onDemand)` Refresh the database with changes from the corresponding backend system (if applicable).
`abstract void`	`updateEntity(EntityValue entity)` Handles the updating of an entity.
`abstract void`	`updateLink(EntityValue source, Property sourceProperty, EntityValue target)` Handles the updating of a link.
`abstract void`	`uploadMedia(EntityValue entity, ByteStream stream)` Handles the uploading of a media stream.
`abstract void`	`uploadStream(EntityValue entity, StreamLink link, ByteStream stream)` Handles the uploading of a stream property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EntityHandler
```
public EntityHandler()
```
- Method Detail
  - allowUnused
```
public void allowUnused(java.lang.Object value)
```
    Helper function so generated subclasses can explicitly ignore a value.
    
    Parameters:
    
    value - Value to be ignored.
  - createEntity
```
public abstract void createEntity(EntityValue entity)
```
    Handles the creation of an entity.
    
    Parameters:
    
    entity - Entity value.
  - createLink
```
public abstract void createLink(EntityValue source,
                                Property sourceProperty,
                                EntityValue target)
```
    Handles the creation of a link.
    
    Parameters:
    
    source - Source entity.
    
    sourceProperty - Source property.
    
    target - Target entity.
  - createMedia
```
public abstract void createMedia(EntityValue entity,
                                 ByteStream stream)
```
    Handles the creation of a media entity.
    
    Parameters:
    
    entity - Media entity.
    
    stream - Input stream, to access uploaded content.
  - deleteEntity
```
public abstract void deleteEntity(EntityValue entity)
```
    Handles the deletion of an entity.
    
    Parameters:
    
    entity - Entity value.
  - deleteLink
```
public abstract void deleteLink(EntityValue source,
                                Property sourceProperty,
                                EntityValue target)
```
    Handles the deletion of a link.
    
    Parameters:
    
    source - Source entity.
    
    sourceProperty - Source property.
    
    target - Target entity.
  - deleteStream
```
public abstract void deleteStream(EntityValue entity,
                                  StreamLink link)
```
    Handles the deletion of a stream property.
    
    Parameters:
    
    entity - Owning entity.
    
    link - Stream link, identifying the stream property the client is deleting.
  - downloadMedia
```
public abstract void downloadMedia(EntityValue entity,
                                   ByteStream stream)
```
    Handles the downloading of a media entity.
    
    Parameters:
    
    entity - Media entity.
    
    stream - Output stream, to receive downloaded content.
  - downloadStream
```
public abstract void downloadStream(EntityValue entity,
                                    StreamLink link,
                                    ByteStream stream)
```
    Handles the downloading of a stream property.
    
    Parameters:
    
    entity - Owning entity.
    
    link - Stream link, identifying the stream property the client is downloading.
    
    stream - Output stream, to receive downloaded content.
  - executeQuery
```
public abstract DataValue executeQuery(DataQuery query)
```
    Handles the execution of a query.
    
    Parameters:
    
    query - Data query.
    
    Returns:
    
    (nullable) Query result.
  - getNameForMetrics
```
public abstract java.lang.String getNameForMetrics()
```
    Return component name for data metrics.
    
    See Also:
    
    DataMetric.component.
    
    Returns:
    
    Component name for data metrics.
  - isBackendHandler
```
public abstract boolean isBackendHandler()
```
    Return does this entity handler delegate to a backend system (as opposed to the main service database).
    
    Returns:
    
    Does this entity handler delegate to a backend system (as opposed to the main service database).
  - loadAll
```
public DataValue loadAll(DataQuery query)
```
    Retrieve all entities (that are to be cached) from the backend system.
    
    See Also:
    
    EntityHandler.refreshCache.
    
    Parameters:
    
    query - Data query for backend call.
    
    Returns:
    
    Single EntityValue or EntityValueList.
  - loadPartition
```
public DataValue loadPartition(DataQuery query,
                               EntityValue partition)
```
    Retrieve all entities for a particular partition (that are to be cached) from the backend system.
    
    See Also:
    
    EntityHandler.refreshCache.
    
    Parameters:
    
    query - Data query for backend call.
    
    partition - Entity identifying the cache partition.
    
    Returns:
    
    Single EntityValue or EntityValueList.
  - refreshAfter
```
public abstract void refreshAfter(EntityHandler priorHandler,
                                  EntitySet priorEntitySet,
                                  EntitySet entitySet)
```
    Register the cache refresh of an entity set to be scheduled after the refresh of a prior entity set.
    
    Parameters:
    
    priorHandler - Entity handler for refresh of the prior entity set.
    
    priorEntitySet - Prior entity set which entitySet will be refreshed after.
    
    entitySet - Entity set to be refreshed after priorEntitySet.
  - refreshCache
```
public abstract void refreshCache(EntitySet entitySet,
                                  boolean onDemand)
```
    Refresh the database with changes from the corresponding backend system (if applicable).
    
    Parameters:
    
    entitySet - Entity set to be refreshed.
    
    onDemand - true for on-demand refresh, false for scheduled refresh.
  - updateEntity
```
public abstract void updateEntity(EntityValue entity)
```
    Handles the updating of an entity.
    
    Parameters:
    
    entity - Entity value.
  - updateLink
```
public abstract void updateLink(EntityValue source,
                                Property sourceProperty,
                                EntityValue target)
```
    Handles the updating of a link.
    
    Parameters:
    
    source - Source entity.
    
    sourceProperty - Source property.
    
    target - Target entity.
  - uploadMedia
```
public abstract void uploadMedia(EntityValue entity,
                                 ByteStream stream)
```
    Handles the uploading of a media stream.
    :
    Parameters:
    
    entity - Owning media entity.
    
    stream - Input stream, to access uploaded content.
  - uploadStream
```
public abstract void uploadStream(EntityValue entity,
                                  StreamLink link,
                                  ByteStream stream)
```
    Handles the uploading of a stream property.
    
    Parameters:
    
    entity - Owning entity.
    
    link - Stream link, identifying the stream property the client is uploading.
    
    stream - Input stream, to access uploaded content.

Class EntityHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityHandler

Method Detail

allowUnused

createEntity

createLink

createMedia

deleteEntity

deleteLink

deleteStream

downloadMedia

downloadStream

executeQuery

getNameForMetrics

isBackendHandler

loadAll

loadPartition

refreshAfter

refreshCache

updateEntity

updateLink

uploadMedia

uploadStream