com.sap.mw.jco
Interface IFunctionTemplate

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
JCO.FunctionTemplate

public interface IFunctionTemplate
extends java.io.Serializable

Encapsulates all meta-data of a function and its import, export, and table parameters. It is used to create a real executable function having the name and parameters as specified by the template.

See Also:
JCO.Function

Method Summary
 java.lang.Object clone()
          Creates a copy of the function template
 JCO.AbapException[] getExceptionList()
          Returns a list of exceptions that can occur in ABAP The exception group will be set to JCO.Exception.JCO_ERROR_ABAP_EXCEPTION, key will contain the exception key while the message will contain a textual description.
 IMetaData getExportParameterList()
          Returns the meta-data for the export parameter list
 JCO.Function getFunction()
          Creates a function object from the template and returns it
 IMetaData getImportParameterList()
          Returns the meta-data for the import parameter list
 java.lang.String getName()
          Return the function name
 JCO.Request getRequest()
          Creates a request object from the template and returns it
 IMetaData getTableParameterList()
          Returns the meta-data for the table parameter list
 java.lang.String toString()
          Returns a string representation of the function template
 

Method Detail

clone

public java.lang.Object clone()
Creates a copy of the function template
Returns:
a clone of this IFunctionTemplate object.

getName

public java.lang.String getName()
Return the function name
Returns:
the name of the function

getImportParameterList

public IMetaData getImportParameterList()
Returns the meta-data for the import parameter list
Returns:
the meta-data for the import parameter list

getExportParameterList

public IMetaData getExportParameterList()
Returns the meta-data for the export parameter list
Returns:
the meta-data for the export parameter list

getTableParameterList

public IMetaData getTableParameterList()
Returns the meta-data for the table parameter list
Returns:
the meta-data for the table parameter list

getExceptionList

public JCO.AbapException[] getExceptionList()
Returns a list of exceptions that can occur in ABAP The exception group will be set to JCO.Exception.JCO_ERROR_ABAP_EXCEPTION, key will contain the exception key while the message will contain a textual description.
Returns:
the ABAP exception list or null if not specified
See Also:
JCO.Exception

toString

public java.lang.String toString()
Returns a string representation of the function template
Overrides:
toString in class java.lang.Object
Returns:
a printable string representation of the template

getFunction

public JCO.Function getFunction()
Creates a function object from the template and returns it
Returns:
the function created from the template

getRequest

public JCO.Request getRequest()
Creates a request object from the template and returns it
Returns:
the request created from the template