com.sapportals.connector.connection

Interface IConnection

All Superinterfaces:

Connection

All Known Implementing Classes:

AbstractConnectorConnection

public interface IConnection
extends Connection

A Connection represents an application-level handle that is used by a client to access the underlying physical connection. The actual physical connection associated with a Connection instance is represented by a ManagedConnection instance. A client gets a Connection instance by using the getConnection method on a ConnectionFactory instance. A connection can be associated with zero or more Interaction instances and can be used for retrieving handles for other interfaces like IFunctionMetaData, IObjectsMetaData.

See Also:

Connection

Method Summary

IInteraction	createInteractionEx() Creates an Interaction associated with this Connection.
IFunctionsMetaData	getFunctionsMetaData() The interface IFunctionsMetaData is the entry point of the EIS functions meta data.
IConnectionMetaData	getMetaDataEx() The interface IConnectionMetaData provides information about an EIS instance connected through a Connection instance.
IObjectsMetaData	getObjectsMetaData() The interface IObjectsMetaData is the entry point of the object model meta data.
IRelationsMetaData	getRelationsMetaData() The interface IRelationsMetaData is the entry point of the object model relations meta data.
IExecution	newExecution() Creates an Execution object enables an application to execute EIS queries.
INativeQuery	newNativeQuery() The interface INativeQuery represents a query in the EIS.
IQuery	newQuery() Deprecated. Use newExecution()
INative	retrieveNative() The interface INative provides a set of handles to various interfaces that an EIS can expose directly to the connector client application.

Methods inherited from interface javax.resource.cci.Connection

close, createInteraction, getLocalTransaction, getMetaData, getResultSetInfo

Method Detail

getMetaDataEx

IConnectionMetaData getMetaDataEx()
                                  throws ConnectorException

The interface IConnectionMetaData provides information about an EIS instance connected through a Connection instance. It provides additional properties about the EIS besides the ones given in JCA ConnectionMetaData interface. A component calls the method Connection.getMetaDataEx to get an IConnectionMetaData instance. Returns the additional properties list for this EIS.

Returns:

IConnectionMetaData additional EIS properties

Throws:

ConnectorException

retrieveNative

INative retrieveNative()
                       throws CapabilityNotSupportedException

The interface INative provides a set of handles to various interfaces that an EIS can expose directly to the connector client application.

Returns:

Native interface to the EIS

Throws:

CapabilityNotSupportedException

See Also:

INative

getObjectsMetaData

IObjectsMetaData getObjectsMetaData()
                                    throws CapabilityNotSupportedException

The interface IObjectsMetaData is the entry point of the object model meta data. Use this interface to investigate the EIS object model.

Returns:

IObjectsMetaData interface

Throws:

CapabilityNotSupportedException

See Also:

IObjectsMetaData

getFunctionsMetaData

IFunctionsMetaData getFunctionsMetaData()
                                        throws CapabilityNotSupportedException

The interface IFunctionsMetaData is the entry point of the EIS functions meta data. Use this interface to investigate the EIS exposed functions or stored procedures.

Returns:

IFunctionsMetaData interface

Throws:

CapabilityNotSupportedException

See Also:

IFunctionsMetaData

getRelationsMetaData

IRelationsMetaData getRelationsMetaData()
                                        throws CapabilityNotSupportedException

The interface IRelationsMetaData is the entry point of the object model relations meta data. Use this interface to investigate the EIS object model relations.

Returns:

IRelationsMetaData interface

Throws:

CapabilityNotSupportedException

See Also:

IRelationsMetaData

newQuery

IQuery newQuery()
                throws CapabilityNotSupportedException

Deprecated. Use newExecution()

The interface IQuery represents a query object in the EIS. Use this interface to build a query object using a specific API for defining the query elements and execute it in the EIS.

Returns:

IQuery interface of new query object

Throws:

CapabilityNotSupportedException

See Also:

IQuery

newNativeQuery

INativeQuery newNativeQuery()
                            throws CapabilityNotSupportedException

The interface INativeQuery represents a query in the EIS. Use this interface to execute a query in the EIS with a given query string.

Returns:

INativeQuery interface of new query object.

Throws:

CapabilityNotSupportedException

See Also:

INativeQuery

createInteractionEx

IInteraction createInteractionEx()
                                 throws CapabilityNotSupportedException

Creates an Interaction associated with this Connection. An Interaction enables an application to execute EIS functions.

Returns:

IInteraction

Throws:

CapabilityNotSupportedException

See Also:

IInteraction

newExecution

IExecution newExecution()
                        throws CapabilityNotSupportedException

Creates an Execution object enables an application to execute EIS queries. This object is the interface for queries originating from the DQE (Distrebuted Query Engine) service

Returns:

IExecution

Throws:

CapabilityNotSupportedException

See Also:

IExecution

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/connectivityfw/api	api	EP-PIN
[sap.com] FRAMEWORK-EXT	[sap.com] tc/conn/connectorframeworkdeprecated	-	EP-CON-CF
[sap.com] FRAMEWORK-EXT	[sap.com] tc/conn/connectorframeworkdeprecated	default	EP-CON-CF