|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface represents the synchronization driver for performing data synchronization with the DB2 Everyplace Sync Server.
Method Summary | |
void |
cancelSync()
User callable cancel of synchronization operation. |
void |
close()
Close the synchronization driver instance. |
java.lang.String |
getPref(int prefID)
Deprecated. Use property version of createSyncService. |
void |
setPref(int prefID,
java.lang.String value)
Deprecated. Use property version of createSyncService. |
void |
setSyncListener(com.ibm.mobileservices.isync.event.ISyncListener listener)
User implemented listener implementation to receive events in eventIssued method |
int |
sync()
Synchronize all subscription sets that are enabled in the specified config store. |
int |
syncConfig()
Synchronize the configuration to obtain subscription set worklist from the server. |
Method Detail |
public int syncConfig() throws ISyncException
Return status descriptions:
throws
- ISyncException with code:
ISyncException
public int sync() throws ISyncException
The sync method launches a synchronization session based on the given config store object. Initially, a subscription set is said to be in RESET mode, if it has never been synchronized before. When the sync engine performs synchronization on that subscription set, it will fetch a complete replica from the SyncServer, which is called a REFRESH operation.
After the refresh is completed, next time when the subscription set is synchronized again, the sync engine will simply synchronize the changed data, which is called a SYNC operation.
See implementations of ISyncDriver for specific information on details pertaining to this method.
Return status descriptions:
throws
- ISyncException with code:
ISyncException
public void cancelSync() throws ISyncException
throws
- ISyncException with code:
ISyncException
public void setSyncListener(com.ibm.mobileservices.isync.event.ISyncListener listener) throws ISyncException
throws
- ISyncException with code:
ISyncException
public java.lang.String getPref(int prefID) throws ISyncException
See ISync.PREF_* for legal values
Returns null if not found.
prefID
- an int specifying the preference ID
throws
- ISyncException with code of:
ISyncException
setPref(int, java.lang.String)
public void setPref(int prefID, java.lang.String value) throws ISyncException
The set of preferences which must be specified is:
throws
- ISyncException with code of :
See Also Implementation specifiec drivers for more detailed documentation.
ISyncException
public void close() throws ISyncException
throws
- ISyncException with code:
ISyncException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |