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.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

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

Method Detail

getUserSystemId

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.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

getDataSourceName

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).

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

getDatabaseName

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).

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0