commonj.connector.metadata.description
Interface InboundFunctionDescription

All Superinterfaces:
FunctionDescription
All Known Subinterfaces:
InboundFunctionDescription

public interface InboundFunctionDescription
extends FunctionDescription

The InboundFunctionDescription interface provides a definition of a function representing an inbound communication to an application server from an EIS instance.

Since:
1.0

Method Summary
 String getEISFunctionName()
          Returns a string value that maps the inbound message to this function.
 
Methods inherited from interface commonj.connector.metadata.description.FunctionDescription
getComment, getImportConfiguration, getInputDataDescription, getName, getOutputDataDescription
 

Method Detail

getEISFunctionName

String getEISFunctionName()
Returns a string value that maps the inbound message to this function.

For example, this function might represent a 'Customer Updated' event from a customer relationship management (CRM) system. The key information for this function (event) might be that it comes from the update of a customer business object. In this case, the EIS function name may be 'Customer_Update' where the adapter has merged the two pieces of key information into a single key string.

At runtime, the FunctionSelector identified in the InboundServiceDescription is passed the inbound listener interface arguments on the generateEISFunctionName() method. This method will return the EIS function name, which in the above example will be 'Customer_Update'.

Returns:
A key string which is used to map the incoming message to this function. The value must not be null.
See Also:
FunctionSelector