commonj.connector.metadata.description
Interface FunctionDescription

All Known Subinterfaces:
InboundFunctionDescription, InboundFunctionDescription, OutboundFunctionDescription, OutboundFunctionDescription

public interface FunctionDescription

The FunctionDescription interface provides the definition of a function for an inbound or outbound service.

Since:
1.0

Method Summary
 String getComment()
          Contains a description of the function populated from information in the EIS.
 MetadataImportConfiguration getImportConfiguration()
          Returns the MetadataImportConfiguration that was used to import and create this function.
 DataDescription getInputDataDescription()
          Returns the input DataDescription.
 String getName()
          Returns the name of the method.
 DataDescription getOutputDataDescription()
          Returns the output DataDescription
 

Method Detail

getName

String getName()
Returns the name of the method. In a service description each function name must be unique. Function overloading is not allowed.

Returns:
The name of the method.

getInputDataDescription

DataDescription getInputDataDescription()
Returns the input DataDescription.

Returns:
Returns the input DataDescription or null if there is no input argument.

getOutputDataDescription

DataDescription getOutputDataDescription()
Returns the output DataDescription

Returns:
Returns the output DataDescription or null if there is no return argument.

getComment

String getComment()
Contains a description of the function populated from information in the EIS. If no pertinent information is available then null can be returned.

This is a locale specific object that should be separated and translated in the EIS, and retrieved using the locale of the tool environment.

Returns:
A String describing the function or null.

getImportConfiguration

MetadataImportConfiguration getImportConfiguration()
Returns the MetadataImportConfiguration that was used to import and create this function.

Returns:
MetadataImportConfiguration used to create this function. Null must not be returned.