public final class

OfflineODataDefiningQuery

extends Object
java.lang.Object
   ↳ com.sap.cloud.mobile.odata.offline.OfflineODataDefiningQuery

Class Overview

A defining query is an OData read request that targets the OData backend associated with the 'OfflineODataProvider' and retrieves a subset of the OData backend data.

Multiple defining queries can be defined for each OData backend.

Defining queries are a subset of data from the OData backend that is sent to the client either during the initial open of the 'OfflineODataProvider' or during a download.

Summary

Public Constructors
OfflineODataDefiningQuery(String name, DataQuery query, boolean automaticallyRetrievesStreams)
Constructs an OfflineODataDefiningQuery
OfflineODataDefiningQuery(String name, String query, boolean automaticallyRetrievesStreams)
Constructs an OfflineODataDefiningQuery
Public Methods
String getName()
Returns name of the defining query.
String getQuery()
Returns the URL string of the defining query.
boolean isAutomaticallyRetrievesStreams()
Returns whether or not to automatically retrieve stream.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public OfflineODataDefiningQuery (String name, DataQuery query, boolean automaticallyRetrievesStreams)

Constructs an OfflineODataDefiningQuery

Parameters
name the name of the defining query.
query the defining query representing in a DataQuery instance.
automaticallyRetrievesStreams if the defining query identifies one or more sets that contain media entities ( entities with an associated media stream ), this property indicates whether or not the associated media streams should be retrieved and included in the Offline store.
See Also
  • com.sap.cloud.mobile.odata.DataQuery

public OfflineODataDefiningQuery (String name, String query, boolean automaticallyRetrievesStreams)

Constructs an OfflineODataDefiningQuery

Parameters
name the name of the defining query.
query the URL string of the defining query.
automaticallyRetrievesStreams if the defining query identifies one or more sets that contain media entities ( entities with an associated media stream ), this property indicates whether or not the associated media streams should be retrieved and included in the Offline store.

Public Methods

public String getName ()

Returns name of the defining query.

Returns
  • the name of the defining query.

public String getQuery ()

Returns the URL string of the defining query.

Returns
  • the URL string of the defining query.

public boolean isAutomaticallyRetrievesStreams ()

Returns whether or not to automatically retrieve stream.

Returns
  • true if it is to automatically retrieve stream, false otherwise.