com.sap.mw.jco
Class JCO.FunctionTemplate

java.lang.Object
  |
  +--com.sap.mw.jco.JCO.FunctionTemplate

public static class JCO.FunctionTemplate

extends java.lang.Object

implements IFunctionTemplate

Encapsulates all meta data of a function and its import, export, and table parameters.

See Also:

Serialized Form

Constructor Summary

JCO.FunctionTemplate(java.lang.String name, IMetaData input, IMetaData output, IMetaData tables, JCO.AbapException[] exceptions)
Creates an instance of the function template

JCO.FunctionTemplate(java.lang.String name, IMetaData input, IMetaData output, IMetaData tables, java.util.Vector exceptions)
Creates an instance of the function template

Method Summary

java.lang.Object	clone() Creates an returns a copy of the IFunctionTemplate object.
JCO.AbapException	getException(java.lang.String key) Returns the ABAP exception for the specified key
JCO.AbapException[]	getExceptionList() Returns the ABAP exception list
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() Returns the name of the function
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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JCO.FunctionTemplate

public JCO.FunctionTemplate(java.lang.String name,
                            IMetaData input,
                            IMetaData output,
                            IMetaData tables,
                            java.util.Vector exceptions)

Creates an instance of the function template

Parameters:

name - the function name

input - the meta data of the import parameter list

output - the meta data of the export parameter list

tables - the meta data of the table parameter list

exceptions - the the exception list as a vector

JCO.FunctionTemplate

public JCO.FunctionTemplate(java.lang.String name,
                            IMetaData input,
                            IMetaData output,
                            IMetaData tables,
                            JCO.AbapException[] exceptions)

Creates an instance of the function template

Parameters:

name - the function name

input - the meta data of the import parameter list

output - the meta data of the export parameter list

tables - the meta data of the table parameter list

exceptions - the exception list as an array

Method Detail

clone

public java.lang.Object clone()

Creates an returns a copy of the IFunctionTemplate object.

Specified by:

clone in interface IFunctionTemplate

Returns:

A clone of this IFunctionTemplate object.

getName

public java.lang.String getName()

Returns the name of the function

Specified by:

getName in interface IFunctionTemplate

Returns:

The name of the function

getImportParameterList

public IMetaData getImportParameterList()

Returns the meta data for the import parameter list

Specified by:

getImportParameterList in interface IFunctionTemplate

Returns:

the meta data for the import parameter list

getExportParameterList

public IMetaData getExportParameterList()

Returns the meta data for the export parameter list

Specified by:

getExportParameterList in interface IFunctionTemplate

Returns:

the meta data for the export parameter list

getTableParameterList

public IMetaData getTableParameterList()

Returns the meta data for the table parameter list

Specified by:

getTableParameterList in interface IFunctionTemplate

Returns:

the meta data for the table parameter list

getExceptionList

public JCO.AbapException[] getExceptionList()

Returns the ABAP exception list

Specified by:

getExceptionList in interface IFunctionTemplate

Returns:

the ABAP exception list or null if none specified

getException

public JCO.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

public JCO.Function getFunction()

Creates a function object from the template and returns it

Specified by:

getFunction in interface IFunctionTemplate

Returns:

a newly created function

getRequest

public JCO.Request getRequest()

Creates a request object from the template and returns it

Specified by:

getRequest in interface IFunctionTemplate

Returns:

a newly created request object

Since:

JCo 2.0

toString

public java.lang.String toString()

Returns a string representation of the function template

Specified by:

toString in interface IFunctionTemplate

Overrides:

toString in class java.lang.Object