BGSyncStatus (Oracle Database Mobile Server API Specification)

java.lang.Object
- oracle.lite.mSync.BGSyncStatus

```
public class BGSyncStatus
extends java.lang.Object
```
BGSyncStatus class represents the current status of automatic synchronization. Status values are in the public fields below. There are also constants defined for various sync and apply states. Note that apply is using only a subset of all the states. Also, the status string values are NLS-translated according to the current language settings of the system.

Field Summary

Fields
Modifier and Type	Field and Description
`short`	`applyProgress` Current progress of the apply task.
`short`	`applyState` Current state of the apply task.
`java.lang.String`	`applyStateStr` String describing the current state of the apply task.
`int`	`batteryPower` Current power level.
`java.lang.String`	`clientId` Client ID (User Name) for which automatic sync is currently running.
`static int`	`FINISHED` Identifier for status "FINISHED".
`static int`	`IDLE` Identifier for status "IDLE".
`short`	`lastApplyError` Error of the last apply task or 0 if there were no apply tasks or last apply task was successful.
`java.lang.String`	`lastApplyErrorMsg` Error message of the last apply task. null if there were no apply tasks, "no error" if the last sync task was successful.
`java.util.Date`	`lastApplyTime` Date and time of the last apply task or null if there were no apply tasks.
`short`	`lastSyncError` Error of the last sync task or 0 if there were no sync tasks or last sync task was successful.
`java.lang.String`	`lastSyncErrorMsg` Error message of the last sync task. null if there were no sync tasks, "no error" if the last sync task was successful.
`java.util.Date`	`lastSyncTime` Date and time of the last sync task or null if there were no sync tasks.
`short`	`lastSyncType` Type of the last sync task (if any).
`java.lang.String`	`networkName` Name of the current network.
`int`	`networkSpeed` Current network bandwidth in bits per second.
`static int`	`PREPARE_FINISH` Identifier for status "PREPARE_FINISH".
`static int`	`PREPARE_START` Identifier for status "PREPARE_START".
`static int`	`PREPARING` Identifier for status "PREPARING".
`static int`	`PROCESS_FINISH` Identifier for status "PROCESS_FINISH".
`static int`	`PROCESS_START` Identifier for status "PROCESS_START".
`static int`	`PROCESSING` Identifier for status "PROCESSING".
`static int`	`RECEIVE_START` Identifier for status "RECEIVE_START".
`static int`	`RECEIVING` Identifier for status "RECEIVING".
`static int`	`RESUMING` Identifier for status "RESUMING".
`static int`	`SEND_FINISH` Identifier for status "SEND_FINISH".
`static int`	`SEND_START` Identifier for status "SEND_START".
`static int`	`SENDING` Identifier for status "SENDING".
`short`	`syncProgress` Current progress of the sync task.
`short`	`syncState` Current state of the sync task.
`java.lang.String`	`syncStateStr` String describing the current state of the sync task.
`static int`	`WAIT_COND` Identifier for status "WAIT_COND".
`static int`	`WAIT_TASK` Identifier for status "WAIT_TASK".

Constructor Summary

Constructors
Constructor and Description

BGSyncStatus()

Constructors
Constructor and Description
`BGSyncStatus()`

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - applyProgress
```
public short applyProgress
```
    Current progress of the apply task. Represented as percentage value ranging from 0 to 100.
  - applyState
```
public short applyState
```
    Current state of the apply task. See state identifiers in this class.
  - applyStateStr
```
public java.lang.String applyStateStr
```
    String describing the current state of the apply task.
  - batteryPower
```
public int batteryPower
```
    Current power level. Represened as percentage value ranging from 0 to 100.
  - clientId
```
public java.lang.String clientId
```
    Client ID (User Name) for which automatic sync is currently running.
  - FINISHED
```
public static final int FINISHED
```
    Identifier for status "FINISHED". Sync or apply task has finished.
    
    See Also:
    Constant Field Values
  - IDLE
```
public static final int IDLE
```
    Identifier for status "IDLE". Sync or apply task is not active at the moment.
    
    See Also:
    Constant Field Values
  - lastApplyError
```
public short lastApplyError
```
    Error of the last apply task or 0 if there were no apply tasks or last apply task was successful. See Oracle Lite documentation for Oracle Lite error code values.
  - lastApplyErrorMsg
```
public java.lang.String lastApplyErrorMsg
```
    Error message of the last apply task. null if there were no apply tasks, "no error" if the last sync task was successful.
  - lastApplyTime
```
public java.util.Date lastApplyTime
```
    Date and time of the last apply task or null if there were no apply tasks.
  - lastSyncError
```
public short lastSyncError
```
    Error of the last sync task or 0 if there were no sync tasks or last sync task was successful. See Oracle Lite documentation for Oracle Lite error code values.
  - lastSyncErrorMsg
```
public java.lang.String lastSyncErrorMsg
```
    Error message of the last sync task. null if there were no sync tasks, "no error" if the last sync task was successful.
  - lastSyncTime
```
public java.util.Date lastSyncTime
```
    Date and time of the last sync task or null if there were no sync tasks.
  - lastSyncType
```
public short lastSyncType
```
    Type of the last sync task (if any). Value 0 means normal sync and value 1 means high priority sync.
  - networkName
```
public java.lang.String networkName
```
    Name of the current network.
  - networkSpeed
```
public int networkSpeed
```
    Current network bandwidth in bits per second.
  - PREPARE_FINISH
```
public static final int PREPARE_FINISH
```
    Identifier for status "PREPARE_FINISH". Sync task has finished preparing.
    
    See Also:
    Constant Field Values
  - PREPARE_START
```
public static final int PREPARE_START
```
    Identifier for status "PREPARE_START". Sync task is entering preparing stage.
    
    See Also:
    Constant Field Values
  - PREPARING
```
public static final int PREPARING
```
    Identifier for status "PREPARING". Sync task is in preparing stage.
    
    See Also:
    Constant Field Values
  - PROCESS_FINISH
```
public static final int PROCESS_FINISH
```
    Identifier for status "PROCESS_FINISH". Sync or apply task has finished to process data.
    
    See Also:
    Constant Field Values
  - PROCESS_START
```
public static final int PROCESS_START
```
    Identifier for status "PROCESS_START". Sync or apply task started to process data.
    
    See Also:
    Constant Field Values
  - PROCESSING
```
public static final int PROCESSING
```
    Identifier for status "PROCESSING". Sync or apply task is processing data.
    
    See Also:
    Constant Field Values
  - RECEIVE_START
```
public static final int RECEIVE_START
```
    Identifier for status "RECEIVE_START". Sync task has started receiving data.
    
    See Also:
    Constant Field Values
  - RECEIVING
```
public static final int RECEIVING
```
    Identifier for status "RECEIVING". Sync task is receiving data.
    
    See Also:
    Constant Field Values
  - RESUMING
```
public static final int RESUMING
```
    Identifier for status "RESUMING". Sync task is resuming after network disconnect.
    
    See Also:
    Constant Field Values
  - SEND_FINISH
```
public static final int SEND_FINISH
```
    Identifier for status "SEND_FINISH". Sync task has finished sending.
    
    See Also:
    Constant Field Values
  - SEND_START
```
public static final int SEND_START
```
    Identifier for status "SEND_START". Sync task is starting to send data.
    
    See Also:
    Constant Field Values
  - SENDING
```
public static final int SENDING
```
    Identifier for status "SENDING". Sync task is sending data.
    
    See Also:
    Constant Field Values
  - syncProgress
```
public short syncProgress
```
    Current progress of the sync task. Represented as percentage value ranging from 0 to 100.
  - syncState
```
public short syncState
```
    Current state of the sync task. See state identifiers in this class.
  - syncStateStr
```
public java.lang.String syncStateStr
```
    String describing the current state of the sync task.
  - WAIT_COND
```
public static final int WAIT_COND
```
    Identifier for status "WAIT_COND". Sync task is waiting on system/database condition(s).
    
    See Also:
    Constant Field Values
  - WAIT_TASK
```
public static final int WAIT_TASK
```
    Identifier for status "WAIT_TASK". Sync or apply task is waiting for other tasks to finish.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - BGSyncStatus
```
public BGSyncStatus()
```

Class BGSyncStatus

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

applyProgress

applyState

applyStateStr

batteryPower

clientId

FINISHED

IDLE

lastApplyError

lastApplyErrorMsg

lastApplyTime

lastSyncError

lastSyncErrorMsg

lastSyncTime

lastSyncType

networkName

networkSpeed

PREPARE_FINISH

PREPARE_START

PREPARING

PROCESS_FINISH

PROCESS_START

PROCESSING

RECEIVE_START

RECEIVING

RESUMING

SEND_FINISH

SEND_START

SENDING

syncProgress

syncState

syncStateStr

WAIT_COND

WAIT_TASK

Constructor Detail

BGSyncStatus