Interface Syncable
-
- All Known Implementing Classes:
InternalHistorianProvider.HistorianSyncable
public interface Syncable
This 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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getKey()
A key to uniquely identify this Syncable to theSyncManager
long
getLastSyncId()
Returns the syncid for the last data synced.int
getSyncableCount(long syncId)
Returns the number of data points that could be synchronized from the given point.SyncSettings
getSyncSettings()
Returns the sync settings used for sending data to remote systems.java.lang.String
getSyncType()
Returns the type of data this Syncable will store (e.g.void
setLastSyncId(long value)
Use to update the most recently synced id.SyncResult
sync(long syncId)
Return true if and only if data was successfully sent to the target
-
-
-
Method Detail
-
getKey
java.lang.String getKey()
A key to uniquely identify this Syncable to theSyncManager
-
getSyncableCount
int getSyncableCount(long syncId)
Returns the number of data points that could be synchronized from the given point.
-
sync
SyncResult sync(long syncId)
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.
-
getSyncSettings
SyncSettings getSyncSettings()
Returns the sync settings used for sending data to remote systems.
-
getSyncType
java.lang.String getSyncType()
Returns the type of data this Syncable will store (e.g. historical, auditing, alarming).
-
getLastSyncId
long getLastSyncId()
Returns the syncid for the last data synced.
-
setLastSyncId
void setLastSyncId(long value)
Use to update the most recently synced id.
-
-