com.sap.aii.af.lib.ra.cci

Interface XIInteractionSpec

All Superinterfaces:

InteractionSpec, Serializable

public interface XIInteractionSpec
extends InteractionSpec

XiInteractionSpec defines the XI 3.0 AF interaction specification. It must be used by a ra implementation if the standard AF ejbs modules are used.

Field Summary

static String	CALL Send an XI message synchronously and return the response (XI AF specific)
static String	SEND Send an XI message asynchronously (XI AF specific)
static int	SYNC_RECEIVE CCI JCA 1.0 standard interaction verb, currently not used by XI AF
static int	SYNC_SEND CCI JCA 1.0 standard interaction verb, must be set for the "Send" function
static int	SYNC_SEND_RECEIVE CCI JCA 1.0 standard interaction verb, must be set for all others than the "Send" function

Method Summary

Integer	getExecutionTimeout() getExecutionTimeout() returns the timeout for synchronous interaction execution.
String	getFunctionName() getFunctionName() retrieves the XI AF specific function name of the function that must be executed with this interaction.
int	getInteractionVerb() getInteractionVerb() gets the JCA CCI interaction verb valid for this interaction.
void	setExecutionTimeout(Integer timeout) setExecutionTimeout() specifies the timeout for synchronous interaction execution.
void	setFunctionName(String functionName) setFunctionName() sets the XI AF specific function name of the function that must be executed with this interaction.
void	setInteractionVerb(int interactionVerb) setInteractionVerb() sets the JCA CCI interaction verb valid for this interaction.

Field Detail

SEND

static final String SEND

Send an XI message asynchronously (XI AF specific)

See Also:

Constant Field Values

CALL

static final String CALL

Send an XI message synchronously and return the response (XI AF specific)

See Also:

Constant Field Values

SYNC_SEND

static final int SYNC_SEND

CCI JCA 1.0 standard interaction verb, must be set for the "Send" function

See Also:

Constant Field Values

SYNC_SEND_RECEIVE

static final int SYNC_SEND_RECEIVE

CCI JCA 1.0 standard interaction verb, must be set for all others than the "Send" function

See Also:

Constant Field Values

SYNC_RECEIVE

static final int SYNC_RECEIVE

CCI JCA 1.0 standard interaction verb, currently not used by XI AF

See Also:

Constant Field Values

Method Detail

setFunctionName

void setFunctionName(String functionName)
                     throws NotSupportedException

setFunctionName() sets the XI AF specific function name of the function that must be executed with this interaction. (JCA CCI)

Parameters:

functionName - One of the constant function names defined above (Send, Call, ...)

Throws:

NotSupportedException - Thrown if specified function name is not supported

setExecutionTimeout

void setExecutionTimeout(Integer timeout)
                         throws NotSupportedException

setExecutionTimeout() specifies the timeout for synchronous interaction execution. Details see JCA specification. (JCA CCI)

Parameters:

timeout - Time in milliseconds to wait for the synchronous execution.

Throws:

NotSupportedException - Thrown if specified verb is not supported

setInteractionVerb

void setInteractionVerb(int interactionVerb)
                        throws NotSupportedException

setInteractionVerb() sets the JCA CCI interaction verb valid for this interaction. Please consider the XI AF specific invariants as specified above. (JCA CCI)

Parameters:

interactionVerb - One of the constant verbs defined above (SYNC_SEND, ...)

Throws:

NotSupportedException - Thrown if specified verb is not supported

getFunctionName

String getFunctionName()

getFunctionName() retrieves the XI AF specific function name of the function that must be executed with this interaction. (JCA CCI)

Returns:

functionName One of the constant function names defined above (Send, Call, ...)

getExecutionTimeout

Integer getExecutionTimeout()

getExecutionTimeout() returns the timeout for synchronous interaction execution. Details see JCA specification. (JCA CCI)

Returns:

timeout Time in milliseconds to wait for the synchronous execution.

getInteractionVerb

int getInteractionVerb()

getInteractionVerb() gets the JCA CCI interaction verb valid for this interaction. Please consider the XI AF specific invariants as specified above. (JCA CCI)

Returns:

interactionVerb One of the constant verbs defined above (SYNC_SEND, ...)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] SAP_XIAF	[sap.com] com.sap.aii.af.lib.facade	api	BC-XI