com.sapportals.connector.execution.functions

Interface IInteraction

All Superinterfaces:

Interaction

public interface IInteraction
extends Interaction

IInteraction enables a component to execute EIS functions. An Interaction instance supports the following ways of interacting with an EIS instance:

1. Execute method that takes an input Record, output Record and an InteractionSpec. This method executes the EIS function represented by the InteractionSpec and updates the output Record.
2. Execute method that takes an input Record and an InteractionSpec. This method implementation executes the EIS function represented by the InteractionSpec and produces the output Record as a return value.

An Interaction instance is created from a Connection and is required to maintain its association with the Connection instance. The close() method releases all resources maintained by the resource adapter for the Interaction. The close() of an Interaction instance should not close the associated Connection instance.

Method Summary

Modifier and Type	Method and Description
Record	execute(IInteractionSpec interactionSpec, Record inputRecord) Executes an interaction represented by the InteractionSpec.
boolean	execute(IInteractionSpec interactionSpec, Record inputRecord, Record outputRecord) Executes an interaction represented by the InteractionSpec.
IInteractionSpec	getInteractionSpec() The interface IInteractionSpec holds properties for driving an Interaction with an EIS instance.
RecordFactory	getRecordFactory() The interface RecordFactory is used for creating MappedRecord and IndexedRecord instances.
IStructureFactory	retrieveStructureFactory() The interface IStructureFactory is used for creating the execution.structures structures objects.

Methods inherited from interface javax.resource.cci.Interaction

clearWarnings, close, execute, execute, getConnection, getWarnings

Method Detail

getInteractionSpec

IInteractionSpec getInteractionSpec()
                             throws ConnectorException

The interface IInteractionSpec holds properties for driving an Interaction with an EIS instance. An InteractionSpec is used by an Interaction to execute the specified function on an underlying EIS.

Returns:

IInteractionSpec for an interaction spec object

Throws:

ConnectorException - if connector is failed

See Also:

IInteractionSpec

retrieveStructureFactory

IStructureFactory retrieveStructureFactory()
                                    throws ConnectorException

The interface IStructureFactory is used for creating the execution.structures structures objects. For example structures that implement the IRecordSet or IRecord can be retrieved using the IStructureFactory, This simplifies for the connector user the creation of complex structures.

Returns:

IStructureFactory for a structure factory object

Throws:

ConnectorException - if connector is failed

See Also:

IStructureFactory

execute

boolean execute(IInteractionSpec interactionSpec,
                Record inputRecord,
                Record outputRecord)
         throws ExecutionException,
                ConnectorException

Executes an interaction represented by the InteractionSpec. This form of invocation takes an input Record and updates the output Record.

Parameters:

interactionSpec - the interaction spec

inputRecord - the input record

outputRecord - the output record

Returns:

boolean

Throws:

ExecutionException - if execution is failed

ConnectorException - if connector is failed

See Also:

Record

execute

Record execute(IInteractionSpec interactionSpec,
               Record inputRecord)
        throws ExecutionException,
               ConnectorException

Executes an interaction represented by the InteractionSpec. This form of invocation takes an input Record and returns an output Record if the execution of the Interaction has been successful.

Parameters:

interactionSpec - interface

inputRecord - the input record

Returns:

Record outputRecord the output record

Throws:

ExecutionException - if execution is failed

ConnectorException - if connector is failed

See Also:

Record

getRecordFactory

RecordFactory getRecordFactory()
                        throws ConnectorException

The interface RecordFactory is used for creating MappedRecord and IndexedRecord instances. Note that the RecordFactory is only used for creation of generic record instances. A CCI implementation provides an implementation class for the RecordFactory interface.

Returns:

RecordFactory

Throws:

ConnectorException - if connector is failed

See Also:

RecordFactory