kotlin-odata/com.sap.cloud.mobile.kotlin.odata/DataSyncProvider

DataSyncProvider

interface DataSyncProvider : DataServiceProvider

A provider interface for data services which can synchronize data between a local database and a backend system.

Inheritors

CloudSyncProvider

Properties

onlineProvider

abstract val onlineProvider: OnlineODataProvider

onlineSetup

abstract var onlineSetup: Boolean

Functions

cancelDownload

abstract fun cancelDownload()

Cancel any download(s) that are currently in progress.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#download(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) DataSyncProvider.download}.

cancelPendingRequests

abstract fun cancelPendingRequests(requests: PendingRequestList?)

Cancel the specifed pending requests. The requests should be cancelled as a batch, which might perform better than calling {@link com.sap.cloud.mobile.kotlin.odata.PendingRequest#cancel() PendingRequest.cancel} one request at a time.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#getQueuedRequests(com.sap.cloud.mobile.kotlin.odata.DataQuery?, com.sap.cloud.mobile.kotlin.odata.http.HttpHeaders?, com.sap.cloud.mobile.kotlin.odata.RequestOptions?) DataSyncProvider.getQueuedRequests}, {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#getFailedRequests(com.sap.cloud.mobile.kotlin.odata.DataQuery?, com.sap.cloud.mobile.kotlin.odata.http.HttpHeaders?, com.sap.cloud.mobile.kotlin.odata.RequestOptions?) DataSyncProvider.getFailedRequests}.

cancelUpload

abstract fun cancelUpload()

Cancel any upload(s) that are currently in progress.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#upload(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) DataSyncProvider.upload}.

clear

abstract fun clear()

Clear this provider. This will {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#close() DataSyncProvider.close} the local database, and then delete the database file(s). If the application has other active threads which may try to use the database while it is being cleared, the deletion of the database file(s) might fail.

abstract fun close()

Close this provider. This will close any connection to the local database held by the current thread. If the application has other active threads which may try to use the database while it is being closed, it might remain open after this call has completed.

createDownloadQuery

abstract fun createDownloadQuery(name: String, query: DataQuery, streams: Boolean)

Create a persistent query to specify criteria for downloading entities for an entity set. This query is persisted across application restarts. Multiple download queries can be defined for the same entity set (e.g. with different filters).

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.DataQuery#entitySet DataQuery.entitySet}, {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#deleteDownloadQuery(kotlin.String) DataSyncProvider.deleteDownloadQuery}, {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#getDownloadQuery(kotlin.String) DataSyncProvider.getDownloadQuery}, {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#getDownloadQueries(com.sap.cloud.mobile.kotlin.odata.EntitySet?) DataSyncProvider.getDownloadQueries}.

deleteDownloadQuery

abstract fun deleteDownloadQuery(name: String)

Delete a persistent query previously created by {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#createDownloadQuery(kotlin.String, com.sap.cloud.mobile.kotlin.odata.DataQuery, kotlin.Boolean) DataSyncProvider.createDownloadQuery}, along with any previously downloaded associated entities. Note: if there is a large number of previously downloaded associated entities, deletion of the download query might be time-consuming.

download

abstract fun download(groups: StringList, options: SyncOptions)

Download backend data changes into the local database.

getDownloadGroup

abstract fun getDownloadGroup(group: String): DownloadGroup

Return a named download group; the group is created if it doesn't exist already.

getDownloadQueries

abstract fun getDownloadQueries(from: EntitySet?): DownloadQueryList

Retrieve all of the persistent queries previously created by {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#createDownloadQuery(kotlin.String, com.sap.cloud.mobile.kotlin.odata.DataQuery, kotlin.Boolean) DataSyncProvider.createDownloadQuery} for a specified entity set.

getDownloadQuery

abstract fun getDownloadQuery(name: String): DownloadQuery?

Retrieve a persistent query previously created by {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#createDownloadQuery(kotlin.String, com.sap.cloud.mobile.kotlin.odata.DataQuery, kotlin.Boolean) DataSyncProvider.createDownloadQuery}.

getEventHistory

abstract fun getEventHistory(query: DataQuery?): SyncEventList

Return a list of the synchronization events since the local database was created.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.SyncEvent#eventID SyncEvent.eventID}, {@link com.sap.cloud.mobile.kotlin.odata.SyncEvent#type SyncEvent.type}, {@link com.sap.cloud.mobile.kotlin.odata.SyncEvent#time SyncEvent.time}, {@link com.sap.cloud.mobile.kotlin.odata.SyncEvent#details SyncEvent.details}.

getFailedRequests

abstract fun getFailedRequests(query: DataQuery?, headers: HttpHeaders?, options: RequestOptions?): PendingRequestList

Return a list of the failed pending requests in the local database (matching the query, if specified). This includes requests that have been sent to the backend system, but which failed to execute successfully.

getPreviousUser

abstract fun getPreviousUser(): String?

Return (nullable) the previous user of the local database (if any).

getQueuedRequests

abstract fun getQueuedRequests(query: DataQuery?, headers: HttpHeaders?, options: RequestOptions?): PendingRequestList

Return a list of the queued pending requests in the local database (matching the query, if specified). This includes requests that have never been sent to the backend system, as well as requests that were previously sent but which failed.

hasFailedRequests

abstract fun hasFailedRequests(query: DataQuery?, headers: HttpHeaders?, options: RequestOptions?): Boolean

Return true if there are any failed requests in the local database (matching the query, if specified).

hasInitialData

abstract fun hasInitialData(): Boolean

Return true if a {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#download(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) DataSyncProvider.download} has previously been successfully executed to obtain initial data for the local database.

hasPendingDownload

abstract fun hasPendingDownload(): Boolean

Return true if a {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#download(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) DataSyncProvider.download} is currently in progress or if the previous download did not terminate normally (i.e. it failed or was cancelled).

hasPendingUpload

abstract fun hasPendingUpload(): Boolean

Return true if an {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#upload(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) DataSyncProvider.upload} is currently in progress or if the previous upload did not terminate normally (i.e. it failed or was cancelled).

hasQueuedRequests

abstract fun hasQueuedRequests(query: DataQuery?, headers: HttpHeaders?, options: RequestOptions?): Boolean

Return true if there are any queued requests in the local database (matching the query, if specified).

lastDownloadTime

abstract fun lastDownloadTime(): GlobalDateTime?

Return (nullable) Date and time for the last {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#download(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) DataSyncProvider.download} request.

lastUploadTime

abstract fun lastUploadTime(): GlobalDateTime?

Return (nullable) Date and time for the last {@link com.sap.cloud.mobile.kotlin.odata.DataSyncProvider#upload(com.sap.cloud.mobile.kotlin.odata.StringList, com.sap.cloud.mobile.kotlin.odata.SyncOptions) DataSyncProvider.upload} request.

open

abstract fun open()

Open this provider. This will create the local database if it doesn't exist already. This might also communicate with the backend system (but only the first time it is called, if metadata is not available locally).

undoPendingChanges

abstract fun undoPendingChanges(entities: EntityValueList)

Undo all pending (local) changes for entities, so they will not be subsequently uploaded.

upload

abstract fun upload(groups: StringList, options: SyncOptions)

Upload data changes for all uploadable entity sets.

uploadDatabaseFile

abstract fun uploadDatabaseFile(encryptionKey: String?, note: String?, options: SyncOptions)

Upload a copy of the local database file (or files) to the backend server (or an intermediary server) for diagnostic purposes. Note: if the local database is encrypted, and encryptionKey is null, this operation might fail (depending on the provider). Note: if the local database is not encrypted, and encryptionKey is non-null, this operation might fail (depending on the provider).