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

java.lang.Object
- com.sap.cloud.server.odata.DataService
- - com.sap.cloud.server.odata.OfflineDataService

public class OfflineDataService
extends DataService

For internal use only.

Constructor Summary

Constructors
Constructor and Description

OfflineDataService(OfflineODataProvider provider)
Construct an offline data service using an offline provider.

Constructors
Constructor and Description
`OfflineDataService(OfflineODataProvider provider)` Construct an offline data service using an offline provider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createEntity(EntityValue entity)` See createEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`createEntity(EntityValue entity, HttpHeaders headers)` See createEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`createEntity(EntityValue entity, HttpHeaders headers, RequestOptions options)` Create an entity in the target system.
`void`	`createLink(EntityValue from, Property property, EntityValue to)` See createLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`createLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers)` See createLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`createLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers, RequestOptions options)` Create a link from a source entity to a target entity in the target system.
`void`	`createMedia(EntityValue entity, StreamBase content)` See createMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
`void`	`createMedia(EntityValue entity, StreamBase content, HttpHeaders headers)` See createMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
`void`	`createMedia(EntityValue entity, StreamBase content, HttpHeaders headers, RequestOptions options)` Create a media entity with the specified content.
`void`	`createRelatedEntity(EntityValue entity, EntityValue parent, Property property)` See createRelatedEntity(EntityValue, EntityValue, Property, HttpHeaders, RequestOptions).
`void`	`createRelatedEntity(EntityValue entity, EntityValue parent, Property property, HttpHeaders headers)` See createRelatedEntity(EntityValue, EntityValue, Property, HttpHeaders, RequestOptions).
`void`	`createRelatedEntity(EntityValue entity, EntityValue parent, Property property, HttpHeaders headers, RequestOptions options)` Create an entity in the target system, related to a parent entity via a parent navigation property.
`void`	`createRelatedMedia(EntityValue entity, StreamBase content, EntityValue parent, Property property)` See createRelatedMedia(EntityValue, StreamBase, EntityValue, Property, HttpHeaders, RequestOptions).
`void`	`createRelatedMedia(EntityValue entity, StreamBase content, EntityValue parent, Property property, HttpHeaders headers)` See createRelatedMedia(EntityValue, StreamBase, EntityValue, Property, HttpHeaders, RequestOptions).
`void`	`createRelatedMedia(EntityValue entity, StreamBase content, EntityValue parent, Property property, HttpHeaders headers, RequestOptions options)` Create an media entity in the target system, related to a parent entity via a parent navigation property.
`void`	`deleteByQuery(DataQuery query)` See deleteByQuery(DataQuery, HttpHeaders, RequestOptions).
`void`	`deleteByQuery(DataQuery query, HttpHeaders headers)` See deleteByQuery(DataQuery, HttpHeaders, RequestOptions).
`void`	`deleteByQuery(DataQuery query, HttpHeaders headers, RequestOptions options)` Execute query to delete data from the target system.
`void`	`deleteEntity(EntityValue entity)` See deleteEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`deleteEntity(EntityValue entity, HttpHeaders headers)` See deleteEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`deleteEntity(EntityValue entity, HttpHeaders headers, RequestOptions options)` Delete an entity from the target system.
`void`	`deleteLink(EntityValue from, Property property)` See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`deleteLink(EntityValue from, Property property, EntityValue to)` See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`deleteLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers)` See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`deleteLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers, RequestOptions options)` Delete a link from a source entity to a target entity.
`void`	`deleteStream(EntityValue entity, StreamLink link)` See deleteStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
`void`	`deleteStream(EntityValue entity, StreamLink link, HttpHeaders headers)` See deleteStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
`void`	`deleteStream(EntityValue entity, StreamLink link, HttpHeaders headers, RequestOptions options)` Delete the content of a stream property from the target system.
`void`	`download()` See download(StringList).
`void`	`download(StringList groups)` Download backend data changes into the local offline store.
`ByteStream`	`downloadMedia(EntityValue entity)` See downloadMedia(EntityValue, HttpHeaders, RequestOptions).
`ByteStream`	`downloadMedia(EntityValue entity, HttpHeaders headers)` See downloadMedia(EntityValue, HttpHeaders, RequestOptions).
`ByteStream`	`downloadMedia(EntityValue entity, HttpHeaders headers, RequestOptions options)` Obtain a stream for downloading the content of a media entity from the target system.
`ByteStream`	`downloadStream(EntityValue entity, StreamLink link)` See downloadStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
`ByteStream`	`downloadStream(EntityValue entity, StreamLink link, HttpHeaders headers)` See downloadStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).
`ByteStream`	`downloadStream(EntityValue entity, StreamLink link, HttpHeaders headers, RequestOptions options)` Obtain a stream for downloading the content of a stream property from the target system.
`DataValue`	`executeMethod(DataMethod method)` See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).
`DataValue`	`executeMethod(DataMethod method, ParameterList parameters)` See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).
`DataValue`	`executeMethod(DataMethod method, ParameterList parameters, HttpHeaders headers)` See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).
`DataValue`	`executeMethod(DataMethod method, ParameterList parameters, HttpHeaders headers, RequestOptions options)` Execute a data method (action or function) in the target system.
`QueryResult`	`executeQuery(DataQuery query)` See executeQuery(DataQuery, HttpHeaders, RequestOptions).
`QueryResult`	`executeQuery(DataQuery query, HttpHeaders headers)` See executeQuery(DataQuery, HttpHeaders, RequestOptions).
`QueryResult`	`executeQuery(DataQuery query, HttpHeaders headers, RequestOptions options)` Execute a data query to get data from the target system.
`PendingRequestList`	`getFailedRequests()` See getFailedRequests(DataQuery).
`PendingRequestList`	`getFailedRequests(DataQuery query)`
`OfflineODataProvider`	`getOfflineProvider()` Return the offline provider supporting this data service.
`OnlineODataProvider`	`getOnlineProvider()` Return the online provider supporting this data service.
`boolean`	`getPrettyTracing()` Return should `OfflineDataService.traceWithData` show pretty-printed JSON/XML content? Defaults to `false`.
`PendingRequestList`	`getQueuedRequests()` See getQueuedRequests(DataQuery).
`PendingRequestList`	`getQueuedRequests(DataQuery query)`
`ServiceOptions`	`getServiceOptions()` Return service options for the associated online provider.
`StorageOptions`	`getStorageOptions()` Return storage options for the associated local database.
`boolean`	`getTraceRequests()` Return should all requests for this data service be traced? Defaults to `false`.
`boolean`	`getTraceWithData()` Return if `OfflineDataService.traceRequests` is also `true`, should all requests for this data service be traced with data? Defaults to `false`.
`void`	`open()` Open the `OfflineDataService.offlineProvider`, performing any necessary initialization such as creation of the local offline store.
`void`	`pingServer()` See pingServer(HttpHeaders, RequestOptions).
`void`	`pingServer(HttpHeaders headers)` See pingServer(HttpHeaders, RequestOptions).
`void`	`pingServer(HttpHeaders headers, RequestOptions options)` Ping the server.
`void`	`processBatch(RequestBatch batch)` See processBatch(RequestBatch, HttpHeaders, RequestOptions).
`void`	`processBatch(RequestBatch batch, HttpHeaders headers)` See processBatch(RequestBatch, HttpHeaders, RequestOptions).
`void`	`processBatch(RequestBatch batch, HttpHeaders headers, RequestOptions options)` Execute a request batch in the target system.
`void`	`setPrettyTracing(boolean value)` Set should `OfflineDataService.traceWithData` show pretty-printed JSON/XML content? Defaults to `false`.
`void`	`setTraceRequests(boolean value)` Set should all requests for this data service be traced? Defaults to `false`.
`void`	`setTraceWithData(boolean value)` Set if `OfflineDataService.traceRequests` is also `true`, should all requests for this data service be traced with data? Defaults to `false`.
`void`	`updateEntity(EntityValue entity)` See updateEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`updateEntity(EntityValue entity, HttpHeaders headers)` See updateEntity(EntityValue, HttpHeaders, RequestOptions).
`void`	`updateEntity(EntityValue entity, HttpHeaders headers, RequestOptions options)` Update an entity in the target system.
`void`	`updateLink(EntityValue from, Property property, EntityValue to)` See updateLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`updateLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers)` See updateLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).
`void`	`updateLink(EntityValue from, Property property, EntityValue to, HttpHeaders headers, RequestOptions options)` Update a link from a source entity to a target entity.
`void`	`upload()` Upload local pending changes to the backend OData service.
`void`	`uploadMedia(EntityValue entity, StreamBase content)` See uploadMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
`void`	`uploadMedia(EntityValue entity, StreamBase content, HttpHeaders headers)` See uploadMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).
`void`	`uploadMedia(EntityValue entity, StreamBase content, HttpHeaders headers, RequestOptions options)` Upload content for a media entity to the target system.
`void`	`uploadStream(EntityValue entity, StreamLink link, StreamBase content)` See uploadStream(EntityValue, StreamLink, StreamBase, HttpHeaders, RequestOptions).
`void`	`uploadStream(EntityValue entity, StreamLink link, StreamBase content, HttpHeaders headers)` See uploadStream(EntityValue, StreamLink, StreamBase, HttpHeaders, RequestOptions).
`void`	`uploadStream(EntityValue entity, StreamLink link, StreamBase content, HttpHeaders headers, RequestOptions options)` Upload content for a stream property to the target system.

Methods inherited from class com.sap.cloud.server.odata.DataService
applyChanges, applyChanges, applyChanges, applyChangesAsync, applyChangesAsync, applyChangesAsync, asyncAction, asyncAction, asyncAction, asyncFunction, asyncFunction, asyncFunction, createEntityAsync, createEntityAsync, createEntityAsync, createLinkAsync, createLinkAsync, createLinkAsync, createMediaAsync, createMediaAsync, createMediaAsync, createRelatedEntityAsync, createRelatedEntityAsync, createRelatedEntityAsync, deleteByQueryAsync, deleteByQueryAsync, deleteByQueryAsync, deleteEntityAsync, deleteEntityAsync, deleteEntityAsync, deleteLinkAsync, deleteLinkAsync, deleteLinkAsync, deleteStreamAsync, deleteStreamAsync, deleteStreamAsync, downloadMediaAsync, downloadMediaAsync, downloadMediaAsync, downloadStreamAsync, downloadStreamAsync, downloadStreamAsync, entityContext, entityContext, entityContext, entityContext, executeMethodAsync, executeMethodAsync, executeMethodAsync, executeQueryAsync, executeQueryAsync, executeQueryAsync, fetchMetadata, fetchMetadata, fetchMetadata, fetchMetadataAsync, fetchMetadataAsync, fetchMetadataAsync, getActionExecutor, getDataMethod, getDataTransaction, getEntitySet, getFunctionExecutor, getMetadata, getMetadataLock, getName, getProvider, hasMetadata, loadEntity, loadEntity, loadEntity, loadEntity, loadEntityAsync, loadEntityAsync, loadEntityAsync, loadMetadata, loadMetadata, loadMetadata, loadMetadataAsync, loadMetadataAsync, loadMetadataAsync, loadProperty, loadProperty, loadProperty, loadProperty, loadPropertyAsync, loadPropertyAsync, loadPropertyAsync, metadataText, pingServerAsync, pingServerAsync, pingServerAsync, processBatchAsync, processBatchAsync, processBatchAsync, queryContext, refreshMetadata, saveEntity, saveEntity, saveEntity, saveEntityAsync, saveEntityAsync, saveEntityAsync, serviceDocument, setActionExecutor, setFunctionExecutor, unloadMetadata, unloadMetadataAsync, unloadMetadataAsync, unloadMetadataAsync, updateEntityAsync, updateEntityAsync, updateEntityAsync, updateLinkAsync, updateLinkAsync, updateLinkAsync, uploadMediaAsync, uploadMediaAsync, uploadMediaAsync, uploadStreamAsync, uploadStreamAsync, uploadStreamAsync, upsertEntity, upsertEntity, upsertEntity

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

Constructor Detail
- OfflineDataService
```
public OfflineDataService(OfflineODataProvider provider)
```
  Construct an offline data service using an offline provider.
  
  Parameters:
  
  provider - Offline provider.

Method Detail

createEntity
```
public void createEntity(EntityValue entity)
```
See createEntity(EntityValue, HttpHeaders, RequestOptions).

Overrides:

createEntity in class DataService

Parameters:

entity - Entity parameter.

createEntity
```
public void createEntity(EntityValue entity,
                         HttpHeaders headers)
```
See createEntity(EntityValue, HttpHeaders, RequestOptions).

Overrides:

createEntity in class DataService

Parameters:

entity - Entity parameter.

headers - Headers parameter.

createEntity

public void createEntity(EntityValue entity,
                         HttpHeaders headers,
                         RequestOptions options)

Create an entity in the target system. Automatically calls CsdlDocument.resolveEntity to ensure that EntityValue.entitySet is available.

See Also:: EntityValue.ofType, EntityValue.inSet.

Example using proxy classes:

 public void createEntityExample() {
     NorthwindService service = this.getService();
     Customer customer = new Customer();
     customer.setCompanyName("Enterprise Inc.");
     customer.setContactName("Jean-Luc Picard");
     service.createEntity(customer);
 }

Example using proxy classes:

 public void createEntityInSetExample() {
     NorthwindService service = this.getService();
     Customer customer = new Customer();
     customer.setCompanyName("Voyager Inc.");
     customer.setContactName("Kathryn Janeway");
     service.createEntity(customer.inSet(NorthwindServiceMetadata.EntitySets.customers));
 }

Example using dynamic API:

 public void createEntityExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property companyNameProperty = customerEntityType.getProperty("CompanyName");
     Property contactNameProperty = customerEntityType.getProperty("ContactName");
     EntityValue customer = EntityValue.ofType(customerEntityType);
     companyNameProperty.setString(customer, "Enterprise Inc.");
     contactNameProperty.setString(customer, "Jean-Luc Picard");
     service.createEntity(customer);
 }

Example using dynamic API:

 public void createEntityInSetExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property companyNameProperty = customerEntityType.getProperty("CompanyName");
     Property contactNameProperty = customerEntityType.getProperty("ContactName");
     EntityValue customer = EntityValue.ofType(customerEntityType);
     companyNameProperty.setString(customer, "Voyager Inc.");
     contactNameProperty.setString(customer, "Kathryn Janeway");
     service.createEntity(customer.inSet(customersEntitySet));
 }

Overrides:: createEntity in class DataService
Parameters:: entity - Entity to be created.; headers - Optional request-specific headers.; options - Optional request-specific options.

createLink
```
public void createLink(EntityValue from,
                       Property property,
                       EntityValue to)
```
See createLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).

Overrides:

createLink in class DataService

Parameters:

from - From parameter.

property - Property parameter.

to - To parameter.

createLink

public void createLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers)

See createLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).

Overrides:: createLink in class DataService
Parameters:: from - From parameter.; property - Property parameter.; to - To parameter.; headers - Headers parameter.

createLink

public void createLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers,
                       RequestOptions options)

Create a link from a source entity to a target entity in the target system.

Example using proxy classes:

 public void createLinkExample() {
     NorthwindService service = this.getService();
     Category category = service.getCategory(new DataQuery().skip(1).top(1));
     Product product = service.getProduct(new DataQuery().top(1));
     service.createLink(category, Category.products, product);
 }

Example using dynamic API:

 public void createLinkExample() {
     DataService service = this.getService();
     EntitySet categoriesEntitySet = service.getEntitySet("Categories");
     EntitySet productsEntitySet = service.getEntitySet("Products");
     EntityType categoryEntityType = categoriesEntitySet.getEntityType();
     Property productsProperty = categoryEntityType.getProperty("Products");
     EntityValue category = service.executeQuery(new DataQuery()
         .from(categoriesEntitySet).skip(1).top(1))
         .getRequiredEntity();
     EntityValue product = service.executeQuery(new DataQuery()
         .from(productsEntitySet).top(1))
         .getRequiredEntity();
     service.createLink(category, productsProperty, product);
 }

Overrides:: createLink in class DataService
Parameters:: from - Source entity for the link to be created.; property - Source navigation property for the link to be created.; to - Target entity for the link to be created.; headers - Optional request-specific headers.; options - Optional request-specific options.

createMedia
```
public void createMedia(EntityValue entity,
                        StreamBase content)
```
See createMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).

Overrides:

createMedia in class DataService

Parameters:

entity - Entity parameter.

content - Content parameter.

createMedia
```
public void createMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers)
```
See createMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).

Overrides:

createMedia in class DataService

Parameters:

entity - Entity parameter.

content - Content parameter.

headers - Headers parameter.

createMedia

public void createMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers,
                        RequestOptions options)

Create a media entity with the specified content. If the entity has non-stream structural properties in addition to the key properties and media content, such as label in the examples below, then this function will send two requests to the server: a first request to upload (POST) the media stream, and a second request (PATCH/PUT) to update the non-stream properties. It is not currently supported to make these two calls atomic. Caution: Having too many threads simultaneously creating streams may result in out-of-memory conditions on memory-constrained devices.

Example using proxy classes:

 public void createMediaExample() {
     MediaService service = this.getService();
     Image image = new Image();
     image.setLabel("Smiley");
     ByteStream content = ByteStream.fromBinary(com.sap.cloud.server.odata.core.StringFunction.toBinary(":-)"));
     content.setMediaType("text/plain");
     service.createMedia(image, content);
 }

Example using dynamic API:

 public void createMediaExample() {
     DataService service = this.getService();
     EntitySet imagesEntitySet = service.getEntitySet("Images");
     EntityType imageEntityType = imagesEntitySet.getEntityType();
     Property labelProperty = imageEntityType.getProperty("label");
     EntityValue image = EntityValue.ofType(imageEntityType);
     labelProperty.setString(image, "Smiley");
     ByteStream content = ByteStream.fromBinary(com.sap.cloud.server.odata.core.StringFunction.toBinary(":-)"));
     content.setMediaType("text/plain");
     service.createMedia(image, content);
 }

Overrides:: createMedia in class DataService
Parameters:: entity - Entity to be created.; content - Initial content. Must be a ByteStream or CharStream. Will be closed before this function returns.; headers - Optional request-specific headers.; options - Optional request-specific options.

createRelatedEntity
```
public void createRelatedEntity(EntityValue entity,
                                EntityValue parent,
                                Property property)
```
See createRelatedEntity(EntityValue, EntityValue, Property, HttpHeaders, RequestOptions).

Overrides:

createRelatedEntity in class DataService

Parameters:

entity - Entity parameter.

parent - Parent parameter.

property - Property parameter.

createRelatedEntity

public void createRelatedEntity(EntityValue entity,
                                EntityValue parent,
                                Property property,
                                HttpHeaders headers)

Overrides:: createRelatedEntity in class DataService
Parameters:: entity - Entity parameter.; parent - Parent parameter.; property - Property parameter.; headers - Headers parameter.

createRelatedEntity

public void createRelatedEntity(EntityValue entity,
                                EntityValue parent,
                                Property property,
                                HttpHeaders headers,
                                RequestOptions options)

Create an entity in the target system, related to a parent entity via a parent navigation property.

See Also:: ChangeSet.createRelatedEntity.

Example using proxy classes:

 public void createRelatedEntityExample() {
     NorthwindService service = this.getService();
     Customer customer = service.getCustomer(new DataQuery().top(1)
         .filter(Customer.customerID.equal("ALFKI")));
     Order__List orders = service.getOrders(new DataQuery().top(1));
     Order newOrder = orders.first().copy();
     service.createRelatedEntity(newOrder, customer, Customer.orders);
 }

Example using dynamic API:

 public void createRelatedEntityExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntitySet ordersEntitySet = service.getEntitySet("Orders");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property customerIDProperty = customerEntityType.getProperty("CustomerID");
     Property ordersProperty = customerEntityType.getProperty("Orders");
     EntityValueList customers = service.executeQuery(new DataQuery()
         .from(customersEntitySet).filter(customerIDProperty.equal("ALFKI")))
         .getEntityList();
     EntityValueList orders = service.executeQuery(new DataQuery()
         .from(ordersEntitySet).top(1))
         .getEntityList();
     EntityValue customer = customers.first();
     EntityValue newOrder = orders.first().copyEntity();
     service.createRelatedEntity(newOrder, customer, ordersProperty);
 }

Overrides:: createRelatedEntity in class DataService
Parameters:: entity - Entity to be created.; parent - Previously created parent entity.; property - Parent's navigation property.; headers - Optional request-specific headers.; options - Optional request-specific options.

createRelatedMedia

public void createRelatedMedia(EntityValue entity,
                               StreamBase content,
                               EntityValue parent,
                               Property property)

Overrides:: createRelatedMedia in class DataService
Parameters:: entity - Entity parameter.; content - Content parameter.; parent - Parent parameter.; property - Property parameter.

createRelatedMedia

public void createRelatedMedia(EntityValue entity,
                               StreamBase content,
                               EntityValue parent,
                               Property property,
                               HttpHeaders headers)

Overrides:: createRelatedMedia in class DataService
Parameters:: entity - Entity parameter.; content - Content parameter.; parent - Parent parameter.; property - Property parameter.; headers - Headers parameter.

createRelatedMedia

public void createRelatedMedia(EntityValue entity,
                               StreamBase content,
                               EntityValue parent,
                               Property property,
                               HttpHeaders headers,
                               RequestOptions options)

Create an media entity in the target system, related to a parent entity via a parent navigation property.

Example using proxy classes:

 public void createRelatedMediaExample() {
     MediaService service = this.getService();
     Artist artist = new Artist();
     artist.setFirstName("Salvador");
     artist.setLastName("Dali");
     artist.setDateOfBirth(LocalDate.of(1904, 5, 11));
     artist.setPlaceOfBirth(GeographyPoint.withLatitudeLongitude(42.266667d,
         2.965d));
     service.createEntity(artist);
     Image image = new Image();
     image.setLabel("Dream");
     ByteStream content = ByteStream.fromBinary(com.sap.cloud.server.odata.core.StringFunction.toBinary("Dream Caused by the Flight of a Bee around a Pomegranate a Second Before Awakening"));
     content.setMediaType("text/plain");
     service.createRelatedMedia(image, content, artist, Artist.images);
 }

Example using dynamic API:

 public void createRelatedMediaExample() {
     DataService service = this.getService();
     EntitySet artistsEntitySet = service.getEntitySet("Artists");
     EntityType artistEntityType = artistsEntitySet.getEntityType();
     Property firstNameProperty = artistEntityType.getProperty("firstName");
     Property lastNameProperty = artistEntityType.getProperty("lastName");
     Property dateOfBirthProperty = artistEntityType.getProperty("dateOfBirth");
     Property placeOfBirthProperty = artistEntityType.getProperty("placeOfBirth");
     Property imagesProperty = artistEntityType.getProperty("images");
     EntitySet imagesEntitySet = service.getEntitySet("Images");
     EntityType imageEntityType = imagesEntitySet.getEntityType();
     Property labelProperty = imageEntityType.getProperty("label");
     EntityValue artist = EntityValue.ofType(artistEntityType);
     firstNameProperty.setString(artist, "Maurits");
     lastNameProperty.setString(artist, "Escher");
     dateOfBirthProperty.setValue(artist, LocalDate.of(1898, 6, 17));
     placeOfBirthProperty.setValue(artist,
         GeographyPoint.withLatitudeLongitude(53.2d, 5.783333d));
     service.createEntity(artist);
     EntityValue image = EntityValue.ofType(imageEntityType);
     labelProperty.setString(image, "Hands");
     ByteStream content = ByteStream.fromBinary(com.sap.cloud.server.odata.core.StringFunction.toBinary("Drawing Hands"));
     content.setMediaType("text/plain");
     service.createRelatedMedia(image, content, artist, imagesProperty);
 }

Overrides:: createRelatedMedia in class DataService
Parameters:: entity - Entity to be created.; content - Initial content. Must be a ByteStream or CharStream. Will be closed before this function returns.; parent - Previously created parent entity.; property - Parent's navigation property.; headers - Optional request-specific headers.; options - Optional request-specific options.

deleteByQuery
```
public void deleteByQuery(DataQuery query)
```
See deleteByQuery(DataQuery, HttpHeaders, RequestOptions).

Overrides:

deleteByQuery in class DataService

Parameters:

query - Query parameter.

deleteByQuery
```
public void deleteByQuery(DataQuery query,
                          HttpHeaders headers)
```
See deleteByQuery(DataQuery, HttpHeaders, RequestOptions).

Overrides:

deleteByQuery in class DataService

Parameters:

query - Query parameter.

headers - Headers parameter.

deleteByQuery
```
public void deleteByQuery(DataQuery query,
                          HttpHeaders headers,
                          RequestOptions options)
```
Execute query to delete data from the target system.

Overrides:

deleteByQuery in class DataService

Parameters:

query - Data query specifying the information to be deleted.

headers - Optional request-specific headers.

options - Optional request-specific options.

deleteEntity
```
public void deleteEntity(EntityValue entity)
```
See deleteEntity(EntityValue, HttpHeaders, RequestOptions).

Overrides:

deleteEntity in class DataService

Parameters:

entity - Entity parameter.

deleteEntity
```
public void deleteEntity(EntityValue entity,
                         HttpHeaders headers)
```
See deleteEntity(EntityValue, HttpHeaders, RequestOptions).

Overrides:

deleteEntity in class DataService

Parameters:

entity - Entity parameter.

headers - Headers parameter.

deleteEntity

public void deleteEntity(EntityValue entity,
                         HttpHeaders headers,
                         RequestOptions options)

Delete an entity from the target system.

Example using proxy classes:

 public void deleteEntityExample() {
     NorthwindService service = this.getService();
     DataQuery query = new DataQuery().top(1).selectKey()
         .filter(Customer.contactName.equal("William Riker"));
     Customer customer = service.getCustomer(query);
     service.deleteEntity(customer);
 }

Example using dynamic API:

 public void deleteEntityExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property contactNameProperty = customerEntityType.getProperty("ContactName");
     DataQuery query = new DataQuery().top(1).selectKey().from(customersEntitySet)
         .filter(contactNameProperty.equal("William Riker"));
     EntityValue customer = service.executeQuery(query).getRequiredEntity();
     service.deleteEntity(customer);
 }

Overrides:: deleteEntity in class DataService
Parameters:: entity - Entity to be deleted.; headers - Optional request-specific headers.; options - Optional request-specific options.

deleteLink
```
public void deleteLink(EntityValue from,
                       Property property)
```
See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).

Overrides:

deleteLink in class DataService

Parameters:

from - From parameter.

property - Property parameter.

deleteLink
```
public void deleteLink(EntityValue from,
                       Property property,
                       EntityValue to)
```
See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).

Overrides:

deleteLink in class DataService

Parameters:

from - From parameter.

property - Property parameter.

to - To parameter.

deleteLink

public void deleteLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers)

See deleteLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).

Overrides:: deleteLink in class DataService
Parameters:: from - From parameter.; property - Property parameter.; to - To parameter.; headers - Headers parameter.

deleteLink

public void deleteLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers,
                       RequestOptions options)

Delete a link from a source entity to a target entity.

Example using proxy classes:

 public void deleteLinkExample1() {
     NorthwindService service = this.getService();
     Product product = service.getProduct(new DataQuery().top(1));
     service.deleteLink(product, Product.supplier);
 }

Example using proxy classes:

 public void deleteLinkExample2() {
     NorthwindService service = this.getService();
     Category category = service.getCategory(new DataQuery().skip(1).top(1));
     Product product = service.getProduct(new DataQuery().top(1));
     service.deleteLink(category, Category.products, product);
 }

Example using dynamic API:

 public void deleteLinkExample1() {
     DataService service = this.getService();
     EntitySet productsEntitySet = service.getEntitySet("Products");
     EntityType productEntityType = productsEntitySet.getEntityType();
     Property supplierProperty = productEntityType.getProperty("Supplier");
     EntityValue product = service.executeQuery(new DataQuery()
         .from(productsEntitySet).top(1))
         .getRequiredEntity();
     service.deleteLink(product, supplierProperty);
 }

Example using dynamic API:

 public void deleteLinkExample2() {
     DataService service = this.getService();
     EntitySet categoriesEntitySet = service.getEntitySet("Categories");
     EntitySet productsEntitySet = service.getEntitySet("Products");
     EntityType categoryEntityType = categoriesEntitySet.getEntityType();
     Property productsProperty = categoryEntityType.getProperty("Products");
     EntityValue category = service.executeQuery(new DataQuery()
         .from(categoriesEntitySet).skip(1).top(1))
         .getRequiredEntity();
     EntityValue product = service.executeQuery(new DataQuery()
         .from(productsEntitySet).top(1))
         .getRequiredEntity();
     service.deleteLink(category, productsProperty, product);
 }

Overrides:: deleteLink in class DataService
Parameters:: from - Source entity for the link to be deleted.; property - Source navigation property for the link to be deleted.; to - Target entity for the link to be deleted. Can be omitted for a single-valued navigation property.; headers - Optional request-specific headers.; options - Optional request-specific options.

deleteStream
```
public void deleteStream(EntityValue entity,
                         StreamLink link)
```
See deleteStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).

Overrides:

deleteStream in class DataService

Parameters:

entity - Entity parameter.

link - Link parameter.

deleteStream
```
public void deleteStream(EntityValue entity,
                         StreamLink link,
                         HttpHeaders headers)
```
See deleteStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).

Overrides:

deleteStream in class DataService

Parameters:

entity - Entity parameter.

link - Link parameter.

headers - Headers parameter.

deleteStream
```
public void deleteStream(EntityValue entity,
                         StreamLink link,
                         HttpHeaders headers,
                         RequestOptions options)
```
Delete the content of a stream property from the target system.

Overrides:

deleteStream in class DataService

Parameters:

entity - Entity containing the stream property whose content is to be deleted.

link - Stream link for the stream to be deleted.

headers - Optional request-specific headers.

options - Optional request-specific options.

download
```
public void download()
```
See download(StringList).

download
```
public void download(StringList groups)
```
Download backend data changes into the local offline store.

Parameters:

groups - If empty, then download from all entity sets. If non-empty, then it specifies groups to be included.

downloadMedia
```
public ByteStream downloadMedia(EntityValue entity)
```
See downloadMedia(EntityValue, HttpHeaders, RequestOptions).

Overrides:

downloadMedia in class DataService

Parameters:

entity - Entity parameter.

Returns:

(see linked method).

downloadMedia
```
public ByteStream downloadMedia(EntityValue entity,
                                HttpHeaders headers)
```
See downloadMedia(EntityValue, HttpHeaders, RequestOptions).

Overrides:

downloadMedia in class DataService

Parameters:

entity - Entity parameter.

headers - Headers parameter.

Returns:

(see linked method).

downloadMedia

public ByteStream downloadMedia(EntityValue entity,
                                HttpHeaders headers,
                                RequestOptions options)

Obtain a stream for downloading the content of a media entity from the target system. Caution: streams are often used for large content that may not fit (all at once) in available application memory. Having too many threads simultaneously downloading streams, or using ByteStream.readAndClose, may result in out-of-memory conditions on memory-constrained devices.

Example using proxy classes:

 public void downloadMediaExample() {
     MediaService service = this.getService();
     DataQuery query = new DataQuery().filter(Image.label.equal("Smiley"))
         .top(1);
     Image image = service.getImage(query);
     ByteStream stream = service.downloadMedia(image);
     byte[] data = stream.readAndClose();
     assert BinaryOperator.equal(data,
         com.sap.cloud.server.odata.core.StringFunction.toBinary(";-)"));
     assert NullableString.hasValue(stream.getMediaType(), "text/plain");
 }

Example using dynamic API:

 public void downloadMediaExample() {
     DataService service = this.getService();
     EntitySet imagesEntitySet = service.getEntitySet("Images");
     EntityType imageEntityType = imagesEntitySet.getEntityType();
     Property labelProperty = imageEntityType.getProperty("label");
     DataQuery query = new DataQuery().from(imagesEntitySet)
         .filter(labelProperty.equal("Smiley")).top(1);
     EntityValue image = service.executeQuery(query).getRequiredEntity();
     ByteStream stream = service.downloadMedia(image);
     byte[] data = stream.readAndClose();
     assert BinaryOperator.equal(data,
         com.sap.cloud.server.odata.core.StringFunction.toBinary(";-)"));
     assert NullableString.hasValue(stream.getMediaType(), "text/plain");
 }

Overrides:: downloadMedia in class DataService
Parameters:: entity - Entity whose content is to be downloaded.; headers - Optional request-specific headers.; options - Optional request-specific options.
Returns:: A stream for downloading the content of a media entity. This must be closed by the caller, or else a resource leak may occur.

downloadStream
```
public ByteStream downloadStream(EntityValue entity,
                                 StreamLink link)
```
See downloadStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).

Overrides:

downloadStream in class DataService

Parameters:

entity - Entity parameter.

link - Link parameter.

Returns:

(see linked method).

downloadStream
```
public ByteStream downloadStream(EntityValue entity,
                                 StreamLink link,
                                 HttpHeaders headers)
```
See downloadStream(EntityValue, StreamLink, HttpHeaders, RequestOptions).

Overrides:

downloadStream in class DataService

Parameters:

entity - Entity parameter.

link - Link parameter.

headers - Headers parameter.

Returns:

(see linked method).

downloadStream

public ByteStream downloadStream(EntityValue entity,
                                 StreamLink link,
                                 HttpHeaders headers,
                                 RequestOptions options)

Obtain a stream for downloading the content of a stream property from the target system. Caution: streams are often used for large content that may not fit (all at once) in available application memory. Having too many threads simultaneously downloading streams, or using ByteStream.readAndClose, may result in out-of-memory conditions on memory-constrained devices.

See Also:: Property.getStreamLink.

Example using proxy classes:

 public void downloadStreamExample() {
     MediaService service = this.getService();
     DataQuery query = new DataQuery().filter(Video.label.equal("Happier"))
         .top(1);
     Video video = service.getVideo(query);
     ByteStream stream = service.downloadStream(video, video.getContent());
     byte[] data = stream.readAndClose();
     assert BinaryOperator.equal(data,
         com.sap.cloud.server.odata.core.StringFunction.toBinary("..."));
     assert NullableString.hasValue(stream.getMediaType(), "text/plain");
 }

Example using dynamic API:

 public void downloadStreamExample() {
     DataService service = this.getService();
     EntitySet videosEntitySet = service.getEntitySet("Videos");
     EntityType videoEntityType = videosEntitySet.getEntityType();
     Property labelProperty = videoEntityType.getProperty("label");
     Property contentProperty = videoEntityType.getProperty("content");
     DataQuery query = new DataQuery().from(videosEntitySet)
         .filter(labelProperty.equal("Happier")).top(1);
     EntityValue video = service.executeQuery(query).getRequiredEntity();
     StreamLink link = contentProperty.getStreamLink(video);
     ByteStream stream = service.downloadStream(video, link);
     byte[] data = stream.readAndClose();
     assert BinaryOperator.equal(data,
         com.sap.cloud.server.odata.core.StringFunction.toBinary("..."));
     assert NullableString.hasValue(stream.getMediaType(), "text/plain");
 }

Overrides:: downloadStream in class DataService
Parameters:: entity - Entity containing the stream property whose content is to be downloaded.; link - Stream link for the stream to be downloaded.; headers - Optional request-specific headers.; options - Optional request-specific options.
Returns:: A stream for downloading the content of a stream property. This must be closed by the caller, or else a resource leak may occur.

executeMethod
```
public DataValue executeMethod(DataMethod method)
```
See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).

Overrides:

executeMethod in class DataService

Parameters:

method - Method parameter.

Returns:

(see linked method).

executeMethod
```
public DataValue executeMethod(DataMethod method,
                               ParameterList parameters)
```
See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).

Overrides:

executeMethod in class DataService

Parameters:

method - Method parameter.

parameters - Parameters parameter.

Returns:

(see linked method).

executeMethod
```
public DataValue executeMethod(DataMethod method,
                               ParameterList parameters,
                               HttpHeaders headers)
```
See executeMethod(DataMethod, ParameterList, HttpHeaders, RequestOptions).

Overrides:

executeMethod in class DataService

Parameters:

method - Method parameter.

parameters - Parameters parameter.

headers - Headers parameter.

Returns:

(see linked method).

executeMethod
```
public DataValue executeMethod(DataMethod method,
                               ParameterList parameters,
                               HttpHeaders headers,
                               RequestOptions options)
```
Execute a data method (action or function) in the target system. Actions may have backend side-effects. Functions should not have backend side-effects.

Overrides:

executeMethod in class DataService

Parameters:

method - Data method.

parameters - Method parameters.

headers - Optional request-specific headers.

options - Optional request-specific options.

Returns:

(nullable) The method result, or null if the method has no result.

executeQuery
```
public QueryResult executeQuery(DataQuery query)
```
See executeQuery(DataQuery, HttpHeaders, RequestOptions).

Overrides:

executeQuery in class DataService

Parameters:

query - Query parameter.

Returns:

(see linked method).

executeQuery
```
public QueryResult executeQuery(DataQuery query,
                                HttpHeaders headers)
```
See executeQuery(DataQuery, HttpHeaders, RequestOptions).

Overrides:

executeQuery in class DataService

Parameters:

query - Query parameter.

headers - Headers parameter.

Returns:

(see linked method).

executeQuery
```
public QueryResult executeQuery(DataQuery query,
                                HttpHeaders headers,
                                RequestOptions options)
```
Execute a data query to get data from the target system.

Overrides:

executeQuery in class DataService

Parameters:

query - Data query specifying the information to be returned.

headers - Optional request-specific headers.

options - Optional request-specific options.

Returns:

The query result.

getFailedRequests
```
public PendingRequestList getFailedRequests()
```
See getFailedRequests(DataQuery).

Returns:

(see linked method).

getFailedRequests

public PendingRequestList getFailedRequests(DataQuery query)

getOfflineProvider
```
public OfflineODataProvider getOfflineProvider()
```
Return the offline provider supporting this data service.

Returns:

The offline provider supporting this data service.

getOnlineProvider
```
public OnlineODataProvider getOnlineProvider()
```
Return the online provider supporting this data service.

See Also:

OfflineODataProvider.onlineProvider.

Returns:

The online provider supporting this data service.

getPrettyTracing
```
public boolean getPrettyTracing()
```
Return should OfflineDataService.traceWithData show pretty-printed JSON/XML content? Defaults to false.

Returns:

Should OfflineDataService.traceWithData show pretty-printed JSON/XML content? Defaults to false.

getQueuedRequests
```
public PendingRequestList getQueuedRequests()
```
See getQueuedRequests(DataQuery).

Returns:

(see linked method).

getQueuedRequests

public PendingRequestList getQueuedRequests(DataQuery query)

getServiceOptions
```
public ServiceOptions getServiceOptions()
```
Return service options for the associated online provider.

Returns:

Service options for the associated online provider.

getStorageOptions
```
public StorageOptions getStorageOptions()
```
Return storage options for the associated local database.

Returns:

Storage options for the associated local database.

getTraceRequests
```
public boolean getTraceRequests()
```
Return should all requests for this data service be traced? Defaults to false.

Returns:

Should all requests for this data service be traced? Defaults to false.

getTraceWithData
```
public boolean getTraceWithData()
```
Return if OfflineDataService.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false. Note that care must be taken when enabling tracing with data, as the resulting log files may contain sensitive information. On the other hand, tracing with data may sometimes be invaluable for troubleshooting purposes.

Returns:

If OfflineDataService.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false.

open
```
public void open()
```
Open the OfflineDataService.offlineProvider, performing any necessary initialization such as creation of the local offline store.

pingServer
```
public void pingServer()
```
See pingServer(HttpHeaders, RequestOptions).

Overrides:

pingServer in class DataService

pingServer
```
public void pingServer(HttpHeaders headers)
```
See pingServer(HttpHeaders, RequestOptions).

Overrides:

pingServer in class DataService

Parameters:

headers - Headers parameter.

pingServer
```
public void pingServer(HttpHeaders headers,
                       RequestOptions options)
```
Ping the server.

Overrides:

pingServer in class DataService

Parameters:

headers - Optional request-specific headers.

options - Optional request-specific options.

processBatch
```
public void processBatch(RequestBatch batch)
```
See processBatch(RequestBatch, HttpHeaders, RequestOptions).

Overrides:

processBatch in class DataService

Parameters:

batch - Batch parameter.

processBatch
```
public void processBatch(RequestBatch batch,
                         HttpHeaders headers)
```
See processBatch(RequestBatch, HttpHeaders, RequestOptions).

Overrides:

processBatch in class DataService

Parameters:

batch - Batch parameter.

headers - Headers parameter.

processBatch

public void processBatch(RequestBatch batch,
                         HttpHeaders headers,
                         RequestOptions options)

Execute a request batch in the target system.

See Also:: RequestBatch.

Example using proxy classes:

 public void processBatchExample() {
     NorthwindService service = this.getService();
     Supplier supplier1 = service.getSupplier(new DataQuery().top(1));
     Supplier supplier2 = supplier1.copy();
     Supplier supplier3 = supplier1.copy();
     Supplier supplier4 = supplier1.copy();
     supplier2.setCompanyName("Alpha Inc.");
     supplier3.setCompanyName("Beta Inc.");
     service.createEntity(supplier2);
     service.createEntity(supplier3);
     supplier3.setCompanyName("Gamma Inc.");
     Product product1 = service.getProduct(new DataQuery().top(1));
     Product product2 = product1.copy();
     product2.setProductName("Delta Cake");
     RequestBatch batch = new RequestBatch();
     ChangeSet changes = new ChangeSet();
     changes.createEntity(supplier4);
     changes.updateEntity(supplier3);
     changes.deleteEntity(supplier2);
     changes.createEntity(product2);
     changes.createLink(product2, Product.supplier, supplier4);
     changes.updateLink(product2, Product.supplier, supplier3);
     changes.deleteLink(product2, Product.supplier, supplier3);
     DataQuery query = new DataQuery()
         .from(NorthwindServiceMetadata.EntitySets.suppliers);
     batch.addChanges(changes);
     batch.addQuery(query);
     service.processBatch(batch);
     Supplier__List suppliers = Supplier.list(batch.getQueryResult(query)
         .getEntityList());
     Example.show("There are now ", Example.formatInt(suppliers.length()),
         " suppliers.");
 }

Example using dynamic API:

 public void processBatchExample() {
     DataService service = this.getService();
     EntitySet suppliersEntitySet = service.getEntitySet("Suppliers");
     EntitySet productsEntitySet = service.getEntitySet("Products");
     EntityType supplierEntityType = suppliersEntitySet.getEntityType();
     Property companyNameProperty = supplierEntityType.getProperty("CompanyName");
     EntityType productEntityType = productsEntitySet.getEntityType();
     Property productNameProperty = productEntityType.getProperty("ProductName");
     Property supplierProperty = productEntityType.getProperty("Supplier");
     EntityValue supplier1 = service.executeQuery(new DataQuery()
         .from(suppliersEntitySet).top(1))
         .getRequiredEntity();
     EntityValue supplier2 = supplier1.copyEntity();
     EntityValue supplier3 = supplier1.copyEntity();
     EntityValue supplier4 = supplier1.copyEntity();
     companyNameProperty.setString(supplier2, "Alpha Inc.");
     companyNameProperty.setString(supplier3, "Beta Inc.");
     service.createEntity(supplier2);
     service.createEntity(supplier3);
     companyNameProperty.setString(supplier3, "Gamma Inc.");
     EntityValue product1 = service.executeQuery(new DataQuery()
         .from(productsEntitySet).top(1))
         .getRequiredEntity();
     EntityValue product2 = product1.copyEntity();
     productNameProperty.setString(product2, "Delta Cake");
     RequestBatch batch = new RequestBatch();
     ChangeSet changes = new ChangeSet();
     changes.createEntity(supplier4);
     changes.updateEntity(supplier3);
     changes.deleteEntity(supplier2);
     changes.createEntity(product2);
     changes.createLink(product2, supplierProperty, supplier4);
     DataQuery query = new DataQuery().from(suppliersEntitySet);
     batch.addChanges(changes);
     batch.addQuery(query);
     service.processBatch(batch);
     EntityValueList suppliers = batch.getQueryResult(query).getEntityList();
     Example.show("There are now ", Example.formatInt(suppliers.length()),
         " suppliers.");
 }

Overrides:: processBatch in class DataService
Parameters:: batch - The request batch.; headers - Optional request-specific headers.; options - Optional request-specific options.

setPrettyTracing
```
public void setPrettyTracing(boolean value)
```
Set should OfflineDataService.traceWithData show pretty-printed JSON/XML content? Defaults to false.

Parameters:

value - Should OfflineDataService.traceWithData show pretty-printed JSON/XML content? Defaults to false.

setTraceRequests
```
public void setTraceRequests(boolean value)
```
Set should all requests for this data service be traced? Defaults to false.

Parameters:

value - Should all requests for this data service be traced? Defaults to false.

setTraceWithData
```
public void setTraceWithData(boolean value)
```
Set if OfflineDataService.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false. Note that care must be taken when enabling tracing with data, as the resulting log files may contain sensitive information. On the other hand, tracing with data may sometimes be invaluable for troubleshooting purposes.

Parameters:

value - If OfflineDataService.traceRequests is also true, should all requests for this data service be traced with data? Defaults to false.

updateEntity
```
public void updateEntity(EntityValue entity)
```
See updateEntity(EntityValue, HttpHeaders, RequestOptions).

Overrides:

updateEntity in class DataService

Parameters:

entity - Entity parameter.

updateEntity
```
public void updateEntity(EntityValue entity,
                         HttpHeaders headers)
```
See updateEntity(EntityValue, HttpHeaders, RequestOptions).

Overrides:

updateEntity in class DataService

Parameters:

entity - Entity parameter.

headers - Headers parameter.

updateEntity

public void updateEntity(EntityValue entity,
                         HttpHeaders headers,
                         RequestOptions options)

Update an entity in the target system.

Example using proxy classes:

 public void updateEntityExample() {
     NorthwindService service = this.getService();
     DataQuery query = new DataQuery().top(1)
         .filter(Customer.contactName.equal("Jean-Luc Picard"));
     Customer customer = service.getCustomer(query);
     customer.setContactName("Beverly Crusher");
     service.updateEntity(customer);
 }

Example using dynamic API:

 public void updateEntityExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property contactNameProperty = customerEntityType.getProperty("ContactName");
     DataQuery query = new DataQuery().top(1).from(customersEntitySet)
         .filter(contactNameProperty.equal("Jean-Luc Picard"));
     EntityValue customer = service.executeQuery(query).getRequiredEntity();
     contactNameProperty.setString(customer, "Beverly Crusher");
     service.updateEntity(customer);
 }

Example using proxy classes:

 public void updateEntityWithReplaceExample() {
     NorthwindService service = this.getService();
     DataQuery query = new DataQuery().top(1)
         .filter(Customer.contactName.equal("Beverly Crusher"));
     Customer customer = service.getCustomer(query);
     customer.setContactName("William Riker");
     RequestOptions options = new RequestOptions();
     options.setUpdateMode(UpdateMode.REPLACE);
     service.updateEntity(customer, com.sap.cloud.server.odata.http.HttpHeaders.empty,
         options);
 }

Example using dynamic API:

 public void updateEntityWithReplaceExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property contactNameProperty = customerEntityType.getProperty("ContactName");
     DataQuery query = new DataQuery().top(1).from(customersEntitySet)
         .filter(contactNameProperty.equal("Beverly Crusher"));
     EntityValue customer = service.executeQuery(query).getRequiredEntity();
     contactNameProperty.setString(customer, "William Riker");
     RequestOptions options = new RequestOptions();
     options.setUpdateMode(UpdateMode.REPLACE);
     service.updateEntity(customer, com.sap.cloud.server.odata.http.HttpHeaders.empty,
         options);
 }

Overrides:: updateEntity in class DataService
Parameters:: entity - Entity to be updated.; headers - Optional request-specific headers.; options - Optional request-specific options.

updateLink
```
public void updateLink(EntityValue from,
                       Property property,
                       EntityValue to)
```
See updateLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).

Overrides:

updateLink in class DataService

Parameters:

from - From parameter.

property - Property parameter.

to - To parameter.

updateLink

public void updateLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers)

See updateLink(EntityValue, Property, EntityValue, HttpHeaders, RequestOptions).

Overrides:: updateLink in class DataService
Parameters:: from - From parameter.; property - Property parameter.; to - To parameter.; headers - Headers parameter.

updateLink

public void updateLink(EntityValue from,
                       Property property,
                       EntityValue to,
                       HttpHeaders headers,
                       RequestOptions options)

Update a link from a source entity to a target entity.

Example using proxy classes:

 public void updateLinkExample() {
     NorthwindService service = this.getService();
     Product product = service.getProduct(new DataQuery().top(1));
     Category category = service.getCategory(new DataQuery().skip(2).top(1));
     service.updateLink(product, Product.category, category);
 }

Example using dynamic API:

 public void updateLinkExample() {
     DataService service = this.getService();
     EntitySet productsEntitySet = service.getEntitySet("Products");
     EntitySet categoriesEntitySet = service.getEntitySet("Categories");
     EntityType productEntityType = productsEntitySet.getEntityType();
     Property categoryProperty = productEntityType.getProperty("Category");
     EntityValue product = service.executeQuery(new DataQuery()
         .from(productsEntitySet).top(1))
         .getRequiredEntity();
     EntityValue category = service.executeQuery(new DataQuery()
         .from(categoriesEntitySet).skip(2).top(1))
         .getRequiredEntity();
     service.updateLink(product, categoryProperty, category);
 }

Overrides:: updateLink in class DataService
Parameters:: from - Source entity for the link to be updated.; property - Source navigation property for the link to be updated. This must be a one-to-one navigation property.; to - Target entity for the link to be updated.; headers - Optional request-specific headers.; options - Optional request-specific options.

upload
```
public void upload()
```
Upload local pending changes to the backend OData service.

uploadMedia
```
public void uploadMedia(EntityValue entity,
                        StreamBase content)
```
See uploadMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).

Overrides:

uploadMedia in class DataService

Parameters:

entity - Entity parameter.

content - Content parameter.

uploadMedia
```
public void uploadMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers)
```
See uploadMedia(EntityValue, StreamBase, HttpHeaders, RequestOptions).

Overrides:

uploadMedia in class DataService

Parameters:

entity - Entity parameter.

content - Content parameter.

headers - Headers parameter.

uploadMedia

public void uploadMedia(EntityValue entity,
                        StreamBase content,
                        HttpHeaders headers,
                        RequestOptions options)

Upload content for a media entity to the target system. Caution: Having too many threads simultaneously uploading streams may result in out-of-memory conditions on memory-constrained devices. Note: this function cannot be used to create a media entity. See DataService.createMedia.

Example using proxy classes:

 public void uploadMediaExample() {
     MediaService service = this.getService();
     DataQuery query = new DataQuery().filter(Image.label.equal("Smiley"))
         .top(1);
     Image image = service.getImage(query);
     ByteStream content = ByteStream.fromBinary(com.sap.cloud.server.odata.core.StringFunction.toBinary(";-)"));
     content.setMediaType("text/plain");
     service.uploadMedia(image, content);
 }

Example using dynamic API:

 public void uploadMediaExample() {
     DataService service = this.getService();
     EntitySet imagesEntitySet = service.getEntitySet("Images");
     EntityType imageEntityType = imagesEntitySet.getEntityType();
     Property labelProperty = imageEntityType.getProperty("label");
     DataQuery query = new DataQuery().from(imagesEntitySet)
         .filter(labelProperty.equal("Smiley")).top(1);
     EntityValue image = service.executeQuery(query).getRequiredEntity();
     ByteStream content = ByteStream.fromBinary(com.sap.cloud.server.odata.core.StringFunction.toBinary(";-)"));
     content.setMediaType("text/plain");
     service.uploadMedia(image, content);
 }

Overrides:: uploadMedia in class DataService
Parameters:: content - Upload stream content. Will be closed before this function returns.; entity - Entity whose content is to be uploaded.; headers - Optional request-specific headers.; options - Optional request-specific options.

uploadStream
```
public void uploadStream(EntityValue entity,
                         StreamLink link,
                         StreamBase content)
```
See uploadStream(EntityValue, StreamLink, StreamBase, HttpHeaders, RequestOptions).

Overrides:

uploadStream in class DataService

Parameters:

entity - Entity parameter.

link - Link parameter.

content - Content parameter.

uploadStream

public void uploadStream(EntityValue entity,
                         StreamLink link,
                         StreamBase content,
                         HttpHeaders headers)

See uploadStream(EntityValue, StreamLink, StreamBase, HttpHeaders, RequestOptions).

Overrides:: uploadStream in class DataService
Parameters:: entity - Entity parameter.; link - Link parameter.; content - Content parameter.; headers - Headers parameter.

uploadStream

public void uploadStream(EntityValue entity,
                         StreamLink link,
                         StreamBase content,
                         HttpHeaders headers,
                         RequestOptions options)

Upload content for a stream property to the target system. Caution: Having too many threads simultaneously uploading streams may result in out-of-memory conditions on memory-constrained devices.

See Also:: Property.getStreamLink.

Example using proxy classes:

 public void uploadStreamExample() {
     MediaService service = this.getService();
     Video video = new Video();
     video.setLabel("Happy");
     ByteStream content = ByteStream.fromBinary(com.sap.cloud.server.odata.core.StringFunction.toBinary("..."));
     content.setMediaType("text/plain");
     service.createEntity(video);
     String contentETagAfterCreate = video.getContent().getEntityTag();
     assert contentETagAfterCreate == null;
     service.uploadStream(video, video.getContent(), content);
     service.loadEntity(video);
     String contentETagAfterUpload = video.getContent().getEntityTag();
     assert contentETagAfterUpload != null;
     video.setLabel("Happier");
     service.updateEntity(video);
     String contentETagAfterUpdate = video.getContent().getEntityTag();
     assert NullableString.equal(contentETagAfterUpdate, contentETagAfterUpload);
 }

Example using dynamic API:

 public void uploadStreamExample() {
     DataService service = this.getService();
     EntitySet videosEntitySet = service.getEntitySet("Videos");
     EntityType videoEntityType = videosEntitySet.getEntityType();
     Property labelProperty = videoEntityType.getProperty("label");
     Property contentProperty = videoEntityType.getProperty("content");
     EntityValue video = EntityValue.ofType(videoEntityType);
     labelProperty.setString(video, "Happy");
     ByteStream content = ByteStream.fromBinary(com.sap.cloud.server.odata.core.StringFunction.toBinary("..."));
     content.setMediaType("text/plain");
     service.createEntity(video);
     StreamLink link = contentProperty.getStreamLink(video);
     String contentETagAfterCreate = link.getEntityTag();
     assert contentETagAfterCreate == null;
     service.uploadStream(video, link, content);
     service.loadEntity(video);
     String contentETagAfterUpload = link.getEntityTag();
     assert contentETagAfterUpload != null;
     labelProperty.setString(video, "Happier");
     service.updateEntity(video);
     String contentETagAfterUpdate = link.getEntityTag();
     assert NullableString.equal(contentETagAfterUpdate, contentETagAfterUpload);
 }

Overrides:: uploadStream in class DataService
Parameters:: entity - Entity containing the stream property whose content is to be uploaded.; link - Stream link for the stream to be uploaded.; content - Upload stream content. Will be closed before this function returns.; headers - Optional request-specific headers.; options - Optional request-specific options.

Class OfflineDataService

Constructor Summary

Method Summary

Methods inherited from class com.sap.cloud.server.odata.DataService

Methods inherited from class java.lang.Object

Constructor Detail

OfflineDataService

Method Detail

createEntity

createEntity

createEntity

createLink

createLink

createLink

createMedia

createMedia

createMedia

createRelatedEntity

createRelatedEntity

createRelatedEntity

createRelatedMedia

createRelatedMedia

createRelatedMedia

deleteByQuery

deleteByQuery

deleteByQuery

deleteEntity

deleteEntity

deleteEntity

deleteLink

deleteLink

deleteLink

deleteLink

deleteStream

deleteStream

deleteStream

download

download

downloadMedia

downloadMedia

downloadMedia

downloadStream

downloadStream

downloadStream

executeMethod

executeMethod

executeMethod

executeMethod

executeQuery

executeQuery

executeQuery

getFailedRequests

getFailedRequests

getOfflineProvider

getOnlineProvider

getPrettyTracing

getQueuedRequests

getQueuedRequests

getServiceOptions

getStorageOptions

getTraceRequests

getTraceWithData

open

pingServer

pingServer

pingServer

processBatch

processBatch

processBatch

setPrettyTracing

setTraceRequests

setTraceWithData

updateEntity

updateEntity

updateEntity

updateLink

updateLink

updateLink

upload

uploadMedia