Interface Syncable
- 
 public interface SyncableThis interface provides functions for sending syncable data to a remote system. A Syncable will place data (e.g. historical, alarming, auditing) in some database store, which will be synced to a remote system at a later date (derived from the synchronization config).
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetKey()A key to uniquely identify this Syncable to theSyncManagerlonggetLastSyncId()Returns the syncid for the last data synced.intgetSyncableCount(long syncId)Returns the number of data points that could be synchronized from the given point.SyncSettingsgetSyncSettings()Returns the sync settings used for sending data to remote systems.java.lang.StringgetSyncType()Returns the type of data this Syncable will store (e.g.voidsetLastSyncId(long value)Use to update the most recently synced id.SyncResultsync(long syncId)Return true if and only if data was successfully sent to the target
 
- 
- 
- 
Method Detail- 
getKeyjava.lang.String getKey() A key to uniquely identify this Syncable to theSyncManager
 - 
getSyncableCountint getSyncableCount(long syncId) Returns the number of data points that could be synchronized from the given point.
 - 
syncSyncResult sync(long syncId) throws java.lang.Exception Return true if and only if data was successfully sent to the target- Parameters:
- syncId- if 0, returns next set of available data based on last query. Otherwise, starts at the given time period.
- Throws:
- java.lang.Exception
 
 - 
getSyncSettingsSyncSettings getSyncSettings() Returns the sync settings used for sending data to remote systems.
 - 
getSyncTypejava.lang.String getSyncType() Returns the type of data this Syncable will store (e.g. historical, auditing, alarming).
 - 
getLastSyncIdlong getLastSyncId() Returns the syncid for the last data synced.
 - 
setLastSyncIdvoid setLastSyncId(long value) Use to update the most recently synced id.
 
- 
 
-