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:
- 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.
- 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.
getInteractionSpec
public 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- See Also:
IInteractionSpec
retrieveStructureFactory
public 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- See Also:
IStructureFactory
execute
public 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:
inputRecord - the input recordoutputRecord - the output record
- Returns:
- boolean
- Throws:
ExecutionException
ConnectorException- See Also:
Record
execute
public 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:
inputRecord - the input record
- Returns:
- Record outputRecord the output record
- Throws:
ExecutionException
ConnectorException- See Also:
Record
getRecordFactory
public 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- See Also:
RecordFactory
Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.