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

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

public class RequestBatch
extends java.lang.Object

Encapsulates an OData batch request.

See Also:: ChangeSet, DataQuery, DataService.processBatch.

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.");
 }

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.");
 }

Constructor Summary

Constructors
Constructor and Description

RequestBatch()

Constructors
Constructor and Description
`RequestBatch()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChanges(ChangeSet changes)` See addChanges(ChangeSet, HttpHeaders, RequestOptions).
`void`	`addChanges(ChangeSet changes, HttpHeaders headers)` See addChanges(ChangeSet, HttpHeaders, RequestOptions).
`void`	`addChanges(ChangeSet changes, HttpHeaders headers, RequestOptions options)` Add a change set to this request batch.
`void`	`addQuery(DataQuery query)` See addQuery(DataQuery, HttpHeaders, RequestOptions).
`void`	`addQuery(DataQuery query, HttpHeaders headers)` See addQuery(DataQuery, HttpHeaders, RequestOptions).
`void`	`addQuery(DataQuery query, HttpHeaders headers, RequestOptions options)` Add a data query to this request batch.
`void`	`addQueryResult(DataQuery query, QueryResult result)` Add a query result to this request batch.
`ChangeSet`	`getChangeSet(int index)` Return the change set, if `isChangeSet(index)` is `true`; otherwise throws `undefined`.
`boolean`	`getContinueOnError()` Return should the server continue executing all requests in a batch if one or nmore of the requests returns an error status.
`DataQuery`	`getDataQuery(int index)` Return the data query, if `isDataQuery(index)` is `true`; otherwise throws `undefined`.
`DataServiceException`	`getError()` Return (nullable) Error if `status` does not represent a successful response.
`DataQuery`	`getFunction(int index)` Return the DataQuery for the Function, if `isFunction(index)` is `true`; otherwise throws `undefined`
`HttpHeaders`	`getHeaders(int index)` Return the HTTP headers for the request at `index`.
`RequestOptions`	`getOptions(int index)` Return the request options for the request at `index`.
`QueryResult`	`getQueryResult(DataQuery query)` Return the result of a data query within this batch.
`int`	`getStatus()` Return response status (e.g.
`DataQuery`	`invokeFunction(DataMethod method)` See invokeFunction(DataMethod, ParameterList, HttpHeaders, RequestOptions).
`DataQuery`	`invokeFunction(DataMethod method, ParameterList parameters)` See invokeFunction(DataMethod, ParameterList, HttpHeaders, RequestOptions).
`DataQuery`	`invokeFunction(DataMethod method, ParameterList parameters, HttpHeaders headers)` See invokeFunction(DataMethod, ParameterList, HttpHeaders, RequestOptions).
`DataQuery`	`invokeFunction(DataMethod method, ParameterList parameters, HttpHeaders headers, RequestOptions options)` Add a function to the batch.
`boolean`	`isChangeSet(int index)` Return `true` if `index` is a valid request index, and the request at that index is a `ChangeSet`; otherwise `false`.
`boolean`	`isDataQuery(int index)` Return `true` if `index` is a valid request index, and the request at that index is a `DataQuery`; otherwise `false`.
`boolean`	`isFunction(int index)` Return `true` if `index` is a valid change index, and the request at that index is for a function
`void`	`setContinueOnError(boolean value)` Set should the server continue executing all requests in a batch if one or nmore of the requests returns an error status.
`void`	`setError(DataServiceException value)` Set error if `status` does not represent a successful response.
`void`	`setStatus(int value)` Set response status (e.g.
`int`	`size()` Return the number of requests in this request batch.

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

- Constructor Detail
  - RequestBatch
```
public RequestBatch()
```
- Method Detail
  - addChanges
```
public void addChanges(ChangeSet changes)
```
    See addChanges(ChangeSet, HttpHeaders, RequestOptions).
    
    Parameters:
    
    changes - Changes parameter.
  - addChanges
```
public void addChanges(ChangeSet changes,
                       HttpHeaders headers)
```
    See addChanges(ChangeSet, HttpHeaders, RequestOptions).
    
    Parameters:
    
    changes - Changes parameter.
    
    headers - Headers parameter.
  - addChanges
```
public void addChanges(ChangeSet changes,
                       HttpHeaders headers,
                       RequestOptions options)
```
    Add a change set to this request batch.
    
    Parameters:
    
    changes - Change set.
    
    headers - Change set headers.
    
    options - Change set options.
  - addQuery
```
public void addQuery(DataQuery query)
```
    See addQuery(DataQuery, HttpHeaders, RequestOptions).
    
    Parameters:
    
    query - Query parameter.
  - addQuery
```
public void addQuery(DataQuery query,
                     HttpHeaders headers)
```
    See addQuery(DataQuery, HttpHeaders, RequestOptions).
    
    Parameters:
    
    query - Query parameter.
    
    headers - Headers parameter.
  - addQuery
```
public void addQuery(DataQuery query,
                     HttpHeaders headers,
                     RequestOptions options)
```
    Add a data query to this request batch.
    
    Parameters:
    
    query - Data query.
    
    headers - Data query headers.
    
    options - Data query options.
  - addQueryResult
```
public void addQueryResult(DataQuery query,
                           QueryResult result)
```
    Add a query result to this request batch.
    
    Parameters:
    
    query - Data query, which must have been previously added to this batch using addQuery.
    
    result - Query result.
  - getChangeSet
```
public ChangeSet getChangeSet(int index)
```
    Return the change set, if isChangeSet(index) is true; otherwise throws undefined.
    
    Parameters:
    
    index - From zero to size - 1.
    
    Returns:
    
    The change set, if isChangeSet(index) is true; otherwise throws undefined.
  - getContinueOnError
```
public boolean getContinueOnError()
```
    Return should the server continue executing all requests in a batch if one or nmore of the requests returns an error status. Defaults to true.
    
    Returns:
    
    Should the server continue executing all requests in a batch if one or nmore of the requests returns an error status. Defaults to true.
  - getDataQuery
```
public DataQuery getDataQuery(int index)
```
    Return the data query, if isDataQuery(index) is true; otherwise throws undefined.
    
    Parameters:
    
    index - From zero to size - 1.
    
    Returns:
    
    The data query, if isDataQuery(index) is true; otherwise throws undefined.
  - getError
```
public DataServiceException getError()
```
    Return (nullable) Error if status does not represent a successful response.
    
    Returns:
    
    (nullable) Error if status does not represent a successful response.
  - getFunction
```
public DataQuery getFunction(int index)
```
    Return the DataQuery for the Function, if isFunction(index) is true; otherwise throws undefined
    
    Parameters:
    
    index - From zero to size - 1
    
    Returns:
    
    The DataQuery for the Function, if isFunction(index) is true; otherwise throws undefined
  - getHeaders
```
public HttpHeaders getHeaders(int index)
```
    Return the HTTP headers for the request at index.
    
    Parameters:
    
    index - From zero to size - 1.
    
    Returns:
    
    The HTTP headers for the request at index.
  - getOptions
```
public RequestOptions getOptions(int index)
```
    Return the request options for the request at index.
    
    Parameters:
    
    index - From zero to size - 1.
    
    Returns:
    
    The request options for the request at index.
  - getQueryResult
```
public QueryResult getQueryResult(DataQuery query)
```
    Return the result of a data query within this batch.
    
    See Also:
    
    RequestBatch.addQuery.
    
    Parameters:
    
    query - Data query.
    
    Returns:
    
    The result of a data query within this batch.
  - getStatus
```
public int getStatus()
```
    Return response status (e.g. HTTP status code 200 = OK).
    
    Returns:
    
    Response status (e.g. HTTP status code 200 = OK).
  - invokeFunction
```
public DataQuery invokeFunction(DataMethod method)
```
    See invokeFunction(DataMethod, ParameterList, HttpHeaders, RequestOptions).
    
    Parameters:
    
    method - Method parameter.
    
    Returns:
    
    (see linked method).
  - invokeFunction
```
public DataQuery invokeFunction(DataMethod method,
                                ParameterList parameters)
```
    See invokeFunction(DataMethod, ParameterList, HttpHeaders, RequestOptions).
    
    Parameters:
    
    method - Method parameter.
    
    parameters - Parameters parameter.
    
    Returns:
    
    (see linked method).
  - invokeFunction
```
public DataQuery invokeFunction(DataMethod method,
                                ParameterList parameters,
                                HttpHeaders headers)
```
    See invokeFunction(DataMethod, ParameterList, HttpHeaders, RequestOptions).
    
    Parameters:
    
    method - Method parameter.
    
    parameters - Parameters parameter.
    
    headers - Headers parameter.
    
    Returns:
    
    (see linked method).
  - invokeFunction
```
public DataQuery invokeFunction(DataMethod method,
                                ParameterList parameters,
                                HttpHeaders headers,
                                RequestOptions options)
```
    Add a function to the batch. If the method is not a function, throws an undefined.
    
    See Also:
    
    DataQuery.bind and DataQuery.from, for setting the binding parameter for a bound function (either can be applied to the returned query).
    
    Parameters:
    
    method - Function to be called.
    
    parameters - Method parameters.
    
    headers - Request-specific headers.
    
    options - Request-specific options.
    
    Returns:
    
    The DataQuery with the function to be invoked in the batch request.
  - isChangeSet
```
public boolean isChangeSet(int index)
```
    Return true if index is a valid request index, and the request at that index is a ChangeSet; otherwise false.
    
    Parameters:
    
    index - From zero to size - 1.
    
    Returns:
    
    true if index is a valid request index, and the request at that index is a ChangeSet; otherwise false.
  - isDataQuery
```
public boolean isDataQuery(int index)
```
    Return true if index is a valid request index, and the request at that index is a DataQuery; otherwise false.
    
    Parameters:
    
    index - From zero to size - 1.
    
    Returns:
    
    true if index is a valid request index, and the request at that index is a DataQuery; otherwise false.
  - isFunction
```
public boolean isFunction(int index)
```
    Return true if index is a valid change index, and the request at that index is for a function
    
    Parameters:
    
    index - From zero to size - 1
    
    Returns:
    
    true if index is a valid change index, and the request at that index is for a function
  - setContinueOnError
```
public void setContinueOnError(boolean value)
```
    Set should the server continue executing all requests in a batch if one or nmore of the requests returns an error status. Defaults to true.
    
    Parameters:
    
    value - Should the server continue executing all requests in a batch if one or nmore of the requests returns an error status. Defaults to true.
  - setError
```
public void setError(DataServiceException value)
```
    Set error if status does not represent a successful response.
    
    Parameters:
    
    value - Error if status does not represent a successful response.
  - setStatus
```
public void setStatus(int value)
```
    Set response status (e.g. HTTP status code 200 = OK).
    
    Parameters:
    
    value - Response status (e.g. HTTP status code 200 = OK).
  - size
```
public int size()
```
    Return the number of requests in this request batch.
    
    Returns:
    
    The number of requests in this request batch.

Class RequestBatch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestBatch

Method Detail

addChanges

addChanges

addChanges

addQuery

addQuery

addQuery

addQueryResult

getChangeSet

getContinueOnError

getDataQuery

getError

getFunction

getHeaders

getOptions

getQueryResult

getStatus

invokeFunction

invokeFunction

invokeFunction

invokeFunction

isChangeSet

isDataQuery

isFunction

setContinueOnError

setError

setStatus

size