com.sapportals.connector.metadata.functions
Interface IFunction

All Superinterfaces:

IConnectorObject, ISOAPSerializable

All Known Subinterfaces:

IMethod

public interface IFunction

extends ISOAPSerializable, IConnectorObject

This interface contains metadata for a specific EIS function

Version:

1.0

Field Summary

static int	RECIEVE_FUNCTION Costant indicates this EIS function has output parameter only
static int	SEND_FUNCTION Costant indicates this EIS function has input parameters only
static int	SEND_RECIEVE_FUNCTION Costant indicates this EIS function has input and output parameters
static int	UNKNOWN_TYPE_FUNCTION Costant indicates this EIS function is of type unknown (non of the above)

Method Summary

java.lang.String	getDescription() Returns the description of the function.
java.util.Set	getExceptions() Returns a set of IFunctionExceptions - the exceptions the function might throw.
int	getFunctionType() Returns the type of the function - whether is sends/receives data in the EIS.
java.lang.String	getName() Returns the name of the function.
IParameter	getParameter(java.lang.String parameterUniqueName) Given a parameter name - returns an IParamter interface for that function parameter.
java.util.List	getParameters() Returns a List of all the function's parameters.
java.util.List	getParameters(int parameterDirection) Returns a List of in/out/inAndOut function's parameters according to the paremeterDirection parameter.
java.lang.String	getUniqueName() Returns the unique name of the function.
java.lang.String	retrieveTerm() Returns the term describing the parameter, for example "Function"

Methods inherited from interface com.sapportals.connector.IConnectorObject

retrieveConnection

Field Detail

SEND_FUNCTION

public static final int SEND_FUNCTION

Costant indicates this EIS function has input parameters only

RECIEVE_FUNCTION

public static final int RECIEVE_FUNCTION

Costant indicates this EIS function has output parameter only

SEND_RECIEVE_FUNCTION

public static final int SEND_RECIEVE_FUNCTION

Costant indicates this EIS function has input and output parameters

UNKNOWN_TYPE_FUNCTION

public static final int UNKNOWN_TYPE_FUNCTION

Costant indicates this EIS function is of type unknown (non of the above)

Method Detail

getExceptions

public java.util.Set getExceptions()
                            throws ConnectorException

Returns a set of IFunctionExceptions - the exceptions the function might throw.

Returns:

A set of exceptions.

See Also:

IFunctionException

getParameters

public java.util.List getParameters()
                             throws ConnectorException

Returns a List of all the function's parameters. The List includes input and output parameters.

Returns:

A List of IParameter interface.

See Also:

IParameter

getParameters

public java.util.List getParameters(int parameterDirection)
                             throws ConnectorException

Returns a List of in/out/inAndOut function's parameters according to the paremeterDirection parameter.

Returns:

A List of IParamter interface.

See Also:

IParameter

getParameter

public IParameter getParameter(java.lang.String parameterUniqueName)
                        throws ParameterNotFoundException,
                               ConnectorException

Given a parameter name - returns an IParamter interface for that function parameter.

Parameters:

parameterUniqueName - The unique name of the parameter.

Returns:

A list of IParamter interface.

See Also:

IParameter

getName

public java.lang.String getName()

Returns the name of the function.

Returns:

The function name.

getUniqueName

public java.lang.String getUniqueName()

Returns the unique name of the function.

Returns:

The function unique name.

getFunctionType

public int getFunctionType()

Returns the type of the function - whether is sends/receives data in the EIS.

Returns:

The function type.

getDescription

public java.lang.String getDescription()

Returns the description of the function.

Returns:

The function description.

retrieveTerm

public java.lang.String retrieveTerm()

Returns the term describing the parameter, for example "Function"

Returns:

The parameter term