com.businessobjects.connectionserver.datasources.ddk
Interface DBEnvironment

public interface DBEnvironment

This interface handles driver environment and configuration information.

Author:

Business Objects

Method Summary

java.lang.String	inquiry(java.lang.String id, java.util.Map params) This method is called by the Business Objects Data Access Layer to query the driver for specific information during connection creation process.
void	validate(ConnectionDefinition definition) This method performs any necessary validation on the connection definition parameters map.

Method Detail

inquiry

java.lang.String inquiry(java.lang.String id,
                         java.util.Map params)
                         throws CSException

This method is called by the Business Objects Data Access Layer to query the driver for specific information during connection creation process. For more information on this interface, refer to the section on the .COD file in the Data Access Developer Guide

Parameters:

id - Inquiry ID

params - A list of parameters: name is the key in the map

Returns:

XML stream containing the results of inquiry

Throws:

CSException

validate

void validate(ConnectionDefinition definition)
              throws CSException

This method performs any necessary validation on the connection definition parameters map. This method is called by Business Objects Data Access layers to validate all connection definition parameters. This interface must be implemented by all custom drivers.

Parameters:

definition - A map containing key and value pairs of all of the parameters necessary to establish a connection.

Throws:

CSException