com.sap.conn.jco
Interface JCoFunctionTemplate

All Superinterfaces:
java.io.Serializable

public interface JCoFunctionTemplate
extends java.io.Serializable

Encapsulates all metadata of a function and its import, changing, export and table parameters as well as the exception list.


Method Summary
 JCoListMetaData getChangingParameterList()
          Returns the meta data for the changing parameter list
 AbapException getException(java.lang.String key)
          Returns the ABAP exception for the specified key
 AbapException[] getExceptionList()
          Returns the ABAP exception list
 JCoListMetaData getExportParameterList()
          Returns the meta data for the export parameter list
 JCoFunction getFunction()
          Creates a function object from the template and returns it
 JCoListMetaData getFunctionInterface()
          Returns the meta data for the function interface, i.e.
 JCoListMetaData getImportParameterList()
          Returns the meta data for the import parameter list
 java.lang.String getName()
          Returns the name of the function
 JCoRequest getRequest()
          Returns a request object for this function template
 JCoListMetaData getTableParameterList()
          Returns the meta data for the table parameter list
 boolean supportsASXML()
          Returns true if this function module is supporting the ASXML semantics for serialization in the RFC protocol.
 

Method Detail

getName

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

Returns:
The name of the function

getImportParameterList

JCoListMetaData getImportParameterList()
Returns the meta data for the import parameter list

Returns:
the meta data for the import parameter list

getExportParameterList

JCoListMetaData getExportParameterList()
Returns the meta data for the export parameter list

Returns:
the meta data for the export parameter list

getChangingParameterList

JCoListMetaData getChangingParameterList()
Returns the meta data for the changing parameter list

Returns:
the meta data for the changing parameter list

getTableParameterList

JCoListMetaData getTableParameterList()
Returns the meta data for the table parameter list

Returns:
the meta data for the table parameter list

getExceptionList

AbapException[] getExceptionList()
Returns the ABAP exception list

Returns:
the ABAP exception list or null if none specified

getException

AbapException getException(java.lang.String key)
Returns the ABAP exception for the specified key

Returns:
the ABAP exception for the specified key or null if not defined

getFunction

JCoFunction getFunction()
Creates a function object from the template and returns it

Returns:
a newly created function

getRequest

JCoRequest getRequest()
Returns a request object for this function template

Returns:
an newly created JCoRequest

getFunctionInterface

JCoListMetaData getFunctionInterface()
Returns the meta data for the function interface, i.e. the complete parameter list

Returns:
the meta data for the function interface, i.e. the complete parameter list

supportsASXML

boolean supportsASXML()
Returns true if this function module is supporting the ASXML semantics for serialization in the RFC protocol.

Returns:
true, if the function module supports ASXML and false if it does not


Copyright © 2008-2014 SAP AG. All Rights Reserved.