net.rim.device.api.database
Class DatabaseOptions

java.lang.Object
  net.rim.device.api.database.DatabaseOptions

public final class DatabaseOptions
extends Object

Defines general database options.

Currently there is one supported option:

• foreign_key_constraints - Can be on or off. This option specifies whether foreign key constraints are enforced. The default is off. The foreign-key constraint enforcement state is not stored in the database file, and thus, it can be set to a different state each time the database is opened. So for example, if a database is created with foreign-key constraints on, it can then be closed and re-opened with foreign-key constraints off. See http://www.sqlite.org/foreignkeys.html for more details on foreign-key support in SQLite.

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 6.0.0

Constructor Summary
	DatabaseOptions() Creates database options with default values.

Method Summary
	boolean	foreignKeyConstraintsOn() Returns whether foreign key constraint is turned ON
	void	set(String key, String value) Sets a new key-value pair.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseOptions

public DatabaseOptions()

Creates database options with default values.

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 6.0.0

Method Detail

set

public void set(String key,
                String value)
         throws DatabaseOptionsSetInvalidKeyException,
                DatabaseOptionsSetInvalidValueException

Sets a new key-value pair.

Parameters:

key - The key to be set; for example, foreign_key_constraints.

value - The value to be set; for example, on or off.

Throws:

DatabaseOptionsSetInvalidKeyException - If an invalid key was specified.

DatabaseOptionsSetInvalidValueException - If an invalid value for a key was specified.

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 6.0.0

foreignKeyConstraintsOn

public boolean foreignKeyConstraintsOn()

Returns whether foreign key constraint is turned ON

Returns:

true if constraint is ON, false otherwise

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 6.0.0