A B C D E F G H I L M N O P Q R S T V W X

A

abort(boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Cancels the current action provided that the data source and the driver support the abort action.

acquire(Object) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionPool

Retrieves a dedicated, non-shareable connection from the pool using the key specified.

acquire(Object, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionPool

Retrieves a connection from the pool using the key specified.

add(Connection) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionPool

Adds a shareable connection, currently in use by the caller, to the Connection Pool.

addInformational(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ErrorManager

Pushes a new error information message onto the error list.

addItem(String, int, long, long, short, boolean, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DescriptionSet

Adds an item to the description set.

addItem(String, int, long, long, short, boolean, boolean, String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.ColumnSet

Adds a new item to the ColumnSet.

addItem(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OwnerSet

Adds a new schema (owner) to the OwnerSet.

addItem(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.QualifierSet

Adds a new qualifier(catalog) to the QualifierSet.

addItem(String, String, String, String, String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.TableSet

Adds a new item to the TableSet.

addItem(String, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

This method adds either a non null String value or null value to the row.

addItem(byte[], boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a non-null byte array value or null value to the row.

addItem(byte, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a byte value or null value to the row.

addItem(short, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a short integer value or null value to the row.

addItem(int, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either an integer value or null value to the row.

addItem(long, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a long integer value or null value to the row.

addItem(float, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a float value or null value to the row.

addItem(double, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a double float value or null value to the row.

addItem(BigDecimal, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a non null BigDecimal value or null value to the row.

addItem(Date, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a non null Date value or null value to the row.

addItem(Date, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a non null Date value or null value to the row.

addItem(Time, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a non null Time value or null value to the row.

addItem(Timestamp, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Record

Adds either a non null Timestamp value or null value to the row.

addParameter(String, String, String, String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition

Adds a connection definition parameter to the map.

addWarning(SQLWarning) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ErrorManager

Pushes a new SQL warning message onto the error list.

addWarning(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ErrorManager

Pushes a new warning message onto the error list.

ARRAY_BIND_SIZE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies the recommended Array Bind Size.

ARRAY_FETCH_SIZE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies how many rows are retrieved from the datasource each time a fetch is performed.

arrayBindSupported() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Tests if the driver supports array binds.

arrayFetchSupported() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Returns True if the driver supports array fetch.

AUTOCONNECT - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies if the Data Access layer must establish a physical connection immediately, or wait for the first SQL statement before establishing a connection.

B

Bean - Interface in com.businessobjects.connectionserver.datasources.ddk.javabean

This is an optional interface that enables the Business Objects Data Access layer JavaBean driver to handle initialization and finalization of the bean.

BeanCollection - Interface in com.businessobjects.connectionserver.datasources.ddk.javabean

This interface lists all beans handled in the context of a JavaBean driver.

bindColumns(DescriptionSet) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Specifies a mapping description for the ResultSet data to Java types.

C

CATALOG_SEPARATOR - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies the catalog separator used to separate data items.

CATEGORY_CONFIGURATION - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition.Parameter

CATEGORY_CREDENTIALS - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition.Parameter

CATEGORY_IDENTIFICATION - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition.Parameter

close() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Connection

Closes the connection.

close(boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Closes all operations and disconnects the driver from the data source.

close() - Method in interface com.businessobjects.connectionserver.datasources.ddk.javabean.Bean

This method is called when the bean instance is no longer required.

COLUMN_NAME_SIZE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies the maximum size for a column name.

ColumnDescription - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides the functionality to get information on the type and properties of a column.

ColumnSet - Interface in com.businessobjects.connectionserver.datasources.ddk.opendriver

This interface allows custom drivers to populate column meta data information.

com.businessobjects.connectionserver.datasources.ddk - package com.businessobjects.connectionserver.datasources.ddk

com.businessobjects.connectionserver.datasources.ddk.javabean - package com.businessobjects.connectionserver.datasources.ddk.javabean

com.businessobjects.connectionserver.datasources.ddk.opendriver - package com.businessobjects.connectionserver.datasources.ddk.opendriver

commit() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Sets that all changes made since the previous commit or rollback operation are made permanent in the data source.

connect() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Establishes a connection to the data source.

Connection - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides functionality for managing connections to a data source.

CONNECTION_SHAREABLE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies if it is possible to share connections to a data source.

ConnectionDefinition - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides functionality for creating new connection definitions, and iterating through existing connection definition parameters.

ConnectionDefinition.Parameter - Interface in com.businessobjects.connectionserver.datasources.ddk

ConnectionPool - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides the functionality to manage connections in BusinessObjects Data Access Layer internal Connection Pool.

connectionProfile(ProfileLogger) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Logs data source-specific profile information.

Context - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface manages connection and driver-specific configuration information.

COST_ESTIMATE_AVAILABLE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that indicates if the driver supports performing cost estimate on queries.

D

DBDriver - Interface in com.businessobjects.connectionserver.datasources.ddk

All custom drivers that implement the DBDriver interface must define the following four additional static methods, as the Business Objects Data Access layer uses the Java reflection API to initialize a new driver.

DBEnvironment - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface handles driver environment and configuration information.

DBMS - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies the database type used to connect to the data source.

DescriptionSet - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides the functionality to handle ResultSet meta data.

disconnect() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Closes the current connection without freeing any ressources.

DriverConfiguration - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides the functionality to access the default configuration information specific for the driver.

duration() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Connection

Returns the time in milliseconds that the connection has been configured to remain open in the connection pool.

E

ErrorManager - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides the functionality for error management.

execute() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Executes the SQL query after it has been processed by the DBDriver.prepare(java.lang.String) method.

F

fetch(int, RecordSet) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Retrieves the result data from the data source.

fetch(int, QualifierSet) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

If the driver supports Qualifiers, fetches at most the requestedSize number of qualifiers.

fetch(int, OwnerSet) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

If the driver supports Owners, fetches at most requestedSize number of owners.

fetch(int, TableSet) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Fetches at most requestedSize number of tables in the tableSet.

fetch(int, ColumnSet) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Fetch at most requestedSize number of columns in the columnSet.

FOREIGNKEYS_AVAILABLE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies if it is possible to retrieve a list of the foreign keys available from the data source.

foreignKeysAvailable() - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Returns True: the driver supports foreign keys.

freeResources() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Cleans up and frees any resources that have been allocated by the driver, for example ResultSet, and open file.

G

getBeans() - Method in interface com.businessobjects.connectionserver.datasources.ddk.javabean.BeanCollection

Lists the class names of all beans used by the driver.

getBigDecimal() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the value of the parameter.

getBoolean(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DriverConfiguration

Returns as a boolean, the default value of the requested parameter as set in the driver's .sbo file.

getBooleanProperty(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Gets the value of a boolean property.

getByte() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the value of the parameter.

getBytes() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the value of the parameter.

getCategory() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition.Parameter

Returns the Connection Definition Category value as a String.

getColumnCount() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Returns the number of columns in a query's result.

getColumnDescriptions(DescriptionSet) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Returns the ResultSet meta data.

getColumns(String, String, String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Gets all the columns for a give table, qualifier and owner.

getConfiguration() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Context

Returns the connection's configuration information as specified in the driver's .sbo file.

getCredentials() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Context

Returns the connection's credential information.

getCurrentOwner() - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Retrieves the current user name as known to this datasource.

getCurrentQualifier() - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Retrieves the current qualifier names available in this datasource.

getDataBase() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Context

Returns the name of the datasource, for example the database, configured when the connection was created.

getDecimalDigits() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ColumnDescription

Returns the number of decimal digits allowed in numerical values.

getDisplaySize() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ColumnDescription

Returns the normal maximum width of the display in characters.

getDouble() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the value of the parameter.

getError(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ErrorManager

Gets an instance of the error object to be thrown.

getError(Throwable) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ErrorManager

Gets an instance of the error object to be thrown.

getError(String, Throwable) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ErrorManager

Gets an instance of the error object to be thrown.

getError(SQLException) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ErrorManager

Gets an instance of the error object to be thrown.

getError(String, String, int) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ErrorManager

Gets an instance of the error object to be thrown.

getError(String, String, int, Throwable) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ErrorManager

Gets an instance of error object to be thrown.

getErrors() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Context

Returns the ErrorManager associated with a connection.

getFloat() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the value of the parameter.

getForeignKeys(String, String, String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Gets the foreign keys associated with a give table based on tableName, owner and qualifer.

getInt() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the value of the parameter.

getInteger(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DriverConfiguration

Returns as an integer, the default value of the requested parameter as set in the driver's .sbo file.

getIntProperty(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Gets the value of an int property.

getJAVAType() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ColumnDescription

Returns the expected Java type for the column's results.

getKey() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Connection

Returns a unique key to use to identify a connection in the pool.

getLocale() - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Returns the locale associated with a property.

getLong() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the value of the parameter.

getMaxColumnNameLength(short) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Returns the maximum size for column's name.

getMaxOwnerNameLength(short) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Returns the maximum size for the owner's name.

getMaxQualifierNameLength(short) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Returns the maximum size for the qualifier's name.

getMaxSize() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Returns the maximum size of a string or an array parameter.

getMaxTableNameLength(short) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Returns the maximum size for table's name.

getName() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ColumnDescription

Returns the column's name.

getObject(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DriverConfiguration

Returns as an object, the default value of the requested parameter as set in the driver's .sbo file.

getObject() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the object embedded in the parameter.

getObjectClass() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the object embedded in the parameter.

getOwners(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Retrieves the owners for a given qualifier(catalog)

getParameterType() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the SQL parameter type as defined in the java.sql.Types class.

getPrimaryKey(String, String, String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Gets the primary key for a table, based on tableName, owner and qualifer.

getProperties() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Context

Returns the configuration properties for a connection.

getProperty(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Gets the value of a property.

getQualifiers() - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Gets all the qualifiers(catalogs) available.

getReferentialDependencies(String, String, String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Gets the foreign key columns that reference the given table's primary key columns.

getShort() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the value of the parameter.

getShortProperty(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Gets the value of a short property.

getSQLType() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ColumnDescription

Returns the column's SQL type.

getString(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DriverConfiguration

Returns as a string, the default value of the requested parameter as set in the driver's .sbo file.

getString() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Retrieves the value of the parameter.

getStringProperty(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Gets the value of a string property

getTables(String, String, String, Collection) - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Fetches all the tables for a given owner, qualifier and pattern.

getType() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition.Parameter

Returns the Connection Definition parameter Type as a string.

getUpdateCount() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Returns the number of records that have been updated by an SQL INSERT or UPDATE statement.

getValue() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition.Parameter

Returns the Connection Definition parameter value as a String.

H

HINT - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies a hint to the SQL optimizer.

I

IDENTIFIER_CASE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies the case behavior of identifiers.

IDENTIFIER_QUOTE_STRING - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies the identifier quote string.

initialize(Context, String, Properties) - Method in interface com.businessobjects.connectionserver.datasources.ddk.javabean.Bean

This method is called after the instantiation of the bean.

inquiry(String, Map) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBEnvironment

This method is called by the Business Objects Data Access Layer to query the driver for specific information during connection creation process.

isAlive() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Connection

Determines if the connection is open and can be used.

isEmpty() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ParameterSet

Determines if a parameter set is empty, that is, if it contains no elements.

isNull() - Method in interface com.businessobjects.connectionserver.datasources.ddk.Parameter

Checks if the parameter value is the SQL Null value.

isNullable() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ColumnDescription

Indicates whether or not a column can contain null values.

isPropertyDefined(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Checks if a property is defined.

isUnsigned() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ColumnDescription

Indicates whether or not numerical values are unsigned numbers.

iterator() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ParameterSet

Returns an iterator for the elements in this collection.

L

LIKE_ESCAPE_CLAUSE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies the LIKE clause escape character.

LOG_TIMEOUT - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies the maximum number of seconds for a login request before the request fails.

M

MAX_ROWS - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that sets the maximum number of rows that can be retrieved from the data source.

maxRowsSupported() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Tests if the driver sets the maximum number of rows that any ResultSet object can contain.

N

NETWORKLAYER - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies the network layer used to connect to the data source.

nextDescription() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DescriptionSet

Returns the next ColumnDescription item in the DescriptionSet.

nextRecord() - Method in interface com.businessobjects.connectionserver.datasources.ddk.RecordSet

The factory method to obtain a new record to be populated.

nextResults() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Boolean that indicates if there are more records to retrieve, for a multi-statement execution.

O

OpenDriver - Interface in com.businessobjects.connectionserver.datasources.ddk.opendriver

This interface defines methods for meta data handling (tables, columns, etc...).

OWNER_NAME_SIZE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies the maximum size for the name of an owner.

OWNERS_AVAILABLE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies if the data source supports owners.

ownersAvailable() - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Returns True: the driver support owners.

OwnerSet - Interface in com.businessobjects.connectionserver.datasources.ddk.opendriver

This interface allows custom drivers to populate schema information.

P

Parameter - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides the functionality to get information about the types and properties of SQL parameters.

ParameterSet - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides custom drivers with the functionality to iterate through a collection of parameters.

PASSWORD_ENCRYPTION - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies if the password must be encrypted.

PERFORM_COST_ESTIMATE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies if the driver must perform cost estimate on queries.

ping() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Pings a data source to check if a connection can be established.

POOL_TIME - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies the number of minutes a connection will be kept alive in the Connection Pool.

prepare(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Checks and prepares an SQL query to be executed on the data source.

prepare(String, ParameterSet) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Checks and prepares a parameterized SQL query to be executed on the data source.

PRIMARYKEY_AVAILABLE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies if it is possible to retrieve the primary key from the data source.

primaryKeyAvailable() - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Returns True: the driver supports primary key.

ProfileLogger - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides the functionality to log driver profile information in XML format.

PropertySet - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides the functionality for maintaining connection-specific configuration properties.

Q

QUALIFIER_NAME_SIZE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies the maximum size for the name of a qualifier.

QUALIFIERS_AVAILABLE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies if the data source supports qualifiers.

qualifiersAvailable() - Method in interface com.businessobjects.connectionserver.datasources.ddk.opendriver.OpenDriver

Returns True if the driver supports qualifiers (catalog).

QualifierSet - Interface in com.businessobjects.connectionserver.datasources.ddk.opendriver

This interface allows custom drivers to populate qualifier(catalog) information.

QUERY_TIMEOUT - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies the maximum number of seconds to wait for any request on the connection to complete before returning to the application.

queryTimeOutSupported() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Tests if the driver supports the setting of an SQL query timeout, that is the setting of a maximum time limit for which an SQL query can run.

QUOTED_IDENTIFIER - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies if a datasource supports quoted identifiers.

QUOTED_IDENTIFIER_CASE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies the case behavior of quoted identifiers.

R

Record - Interface in com.businessobjects.connectionserver.datasources.ddk

This interface provides the custom driver with the functionality to fetch and populate a single row of data retrieved from the data source.

RecordSet - Interface in com.businessobjects.connectionserver.datasources.ddk

RecordSet represents a collection of result records.

release(Connection) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionPool

Returns a non-shareable connection to the Connection Pool when it is no longer required.

release(Connection, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionPool

Returns a shareable connection to the Connection Pool when it is no longer required.

rollback() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Rolls back all changes made by the current transaction, and releases any resources that the current transaction is using.

S

SEARCH_PATTERN_ESCAPE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies the SEARCH clause escape character.

setArrayBindSize(int) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Sets the number of rows exported with the SQL INSERT command.

setArrayFetchSize(int) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Sets the maximum number of records that can be retrieved from the driver at a time.

setBooleanProperty(String, boolean) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Sets a boolean property's value.

setDuration(long) - Method in interface com.businessobjects.connectionserver.datasources.ddk.Connection

Sets the time in milliseconds that the connection is to remain open in the internal connection pool.

setIntProperty(String, int) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Sets an int property's value

setMaxRows(int) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Sets the maximum number of rows that any ResultSet object can contain.

setProperty(String, Object) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Sets a property's value.

setQueryTimeOut(int) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBDriver

Sets the maximum time in seconds that an SQL query operation can run before the driver cancels the query.

setShortProperty(String, short) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Sets a short property's value.

setStringProperty(String, String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Sets a string property's value.

SHARED_CONNECTION - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Boolean property that specifies whether or not connections to the data source are shared for this driver.

size() - Method in interface com.businessobjects.connectionserver.datasources.ddk.DescriptionSet

Returns the number of ColumnDescription items in this DescriptionSet.

size() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ParameterSet

Determines the number of elements in a parameter collection.

T

TABLE_NAME_SIZE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies the maximum size for a table name.

TableSet - Interface in com.businessobjects.connectionserver.datasources.ddk.opendriver

This interface allows custom drivers to populate table meta data information.

toArray() - Method in interface com.businessobjects.connectionserver.datasources.ddk.ParameterSet

Retrieves the parameters in a collection.

toArray(Object[]) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ParameterSet

Retrieves the parameters in a collection and returns them in an array.

TRANSACTION_TYPE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

String property that specifies the transaction type.

tryLock(Connection) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionPool

Tests a connection to determine if it is in use.

TYPE_BOOL - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition.Parameter

TYPE_INT - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition.Parameter

TYPE_STRING - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.ConnectionDefinition.Parameter

V

validate(ConnectionDefinition) - Method in interface com.businessobjects.connectionserver.datasources.ddk.DBEnvironment

This method performs any necessary validation on the connection definition parameters map.

W

writeInformation(String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ProfileLogger

Logs profile information with a message only, that is without any data, to the logger.

writeInformation(String, String) - Method in interface com.businessobjects.connectionserver.datasources.ddk.ProfileLogger

Logs profile information with a message and data to the logger.

X

XML_MAX_SIZE - Static variable in interface com.businessobjects.connectionserver.datasources.ddk.PropertySet

Integer property that specifies the maximum size for an XML column.

A B C D E F G H I L M N O P Q R S T V W X