com.sapportals.connector.execution.functions

Interface IInteractionSpec

All Superinterfaces:

InteractionSpec, Serializable

public interface IInteractionSpec
extends InteractionSpec

An InteractionSpec holds interaction 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. The CCI specification defines a set of standard properties for an InteractionSpec. Every interaction Property is represented by and IInteractionProperty implementation. An IInteractionProperty metadata is represented by an IInteractionSpecMetaData object. An InteractionSpec implementation is not required to support a standard property if that property does not apply to its underlying EIS. The InteractionSpec implementation class must provide getter and setter methods for each of its supported properties. The getter and setter methods convention should be based on the Java Beans design pattern. The standard properties are as follows:

• FunctionName: name of an EIS function
• InteractionVerb: mode of interaction with an EIS instance: SYNC_SEND, SYNC_SEND_RECEIVE, SYNC_RECEIVE
• ExecutionTimeout: the number of milliseconds an Interaction will wait for an EIS to execute the specified function The following standard properties are used to give hints to an Interaction instance about the ResultSet requirements: FetchSize FetchDirection MaxFieldSize ResultSetType ResultSetConcurrency A CCI implementation can provide additional properties beyond that described in the InteractionSpec interface. Note that the format and type of the additional properties is specific to an EIS and is outside the scope of the CCI specification. It is required that the InteractionSpec interface be implemented as a JavaBean for tool support. The properties on the InteractionSpec implementation class should be defined through the getter and setter methods pattern. An implementation class for InteractionSpec interface is required to implement the java.io.Serializable interface.

Field Summary

Fields inherited from interface javax.resource.cci.InteractionSpec

SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE

Method Summary

Modifier and Type	Method and Description
Set<Map.Entry<String,Object>>	getAllInteractionProperties() Returns a set of pairs (entries) of names and values of IInteractionProperty objects
Object	getPropertyValue(String propertyName) Get the value of one interaction property
IInteractionSpecMetaData	retrieveInteractionSpecMetaData() Retrieve the metaData for an InteractionSpec
void	setPropertyValue(String propertyName, Object propertyValue) Set the value of one interaction property

Method Detail

setPropertyValue

void setPropertyValue(String propertyName,
                      Object propertyValue)

Set the value of one interaction property

Parameters:

propertyName - The name of the interaction property to set value for

propertyValue - The new interaction property value

getPropertyValue

Object getPropertyValue(String propertyName)

Get the value of one interaction property

Parameters:

propertyName - the name of the interaction property to set value for

Returns:

propertyValue

retrieveInteractionSpecMetaData

IInteractionSpecMetaData retrieveInteractionSpecMetaData()

Retrieve the metaData for an InteractionSpec

Returns:

IInteractionSpecMetaData metadata for InteractionSpec

getAllInteractionProperties

Set<Map.Entry<String,Object>> getAllInteractionProperties()

Returns a set of pairs (entries) of names and values of IInteractionProperty objects

Returns:

Set containing all interaction properties