net.rim.device.api.synchronization
Interface OTASyncParametersProvider


public interface OTASyncParametersProvider

Interface for classes that want to provide explicit settings for some/all of the parameters required for OTA synchronization or backup/restore.

Since:
JDE 4.0.0

Method Summary
 String getDatabaseName()
          Get the name of the database to use.
 String getDataSourceName()
          Get the name of the data source to use.
 String getUserSystemId()
          Get the User System Id to use.
 

Method Detail

getUserSystemId

public String getUserSystemId()
Get the User System Id to use.
Returns:
The User System ID to use. Returning null from this method will indicate that the default User System Id should be used.
Since:
JDE 4.0.0

getDataSourceName

public String getDataSourceName()
Get the name of the data source to use.
Returns:
The name of the data source to use. Returning null from this method will indicate that the default data source should be used (e.g. the default sync or backup/restore data source name as appropriate).
Since:
JDE 4.0.0

getDatabaseName

public String getDatabaseName()
Get the name of the database to use. NOTE: Unlike the SyncCollection name (returned via SyncCollection.getSyncName()), the database name does not need to be unique across all SyncCollections. Further, if the same SyncCollection is being registered with different service UIDs, the database name must be the same for each.
Returns:
The name of the database to use. Returning null from this method will indicate that the default database name should be used (e.g. the name of the SyncCollection).
Since:
JDE 4.0.0


Copyright 1999-2004 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.