com.sapportals.connector.metadata.functions

Interface IFunction

All Superinterfaces:

IConnectorObject, IGenericElement, ISOAPSerializable

All Known Subinterfaces:

ExtensibleMetadataFunction, IMethod

public interface IFunction
extends ISOAPSerializable, IGenericElement

This interface contains metadata for a specific EIS function

Field Summary

Fields

Modifier and Type	Field and Description
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)

Fields inherited from interface com.sapportals.connector.metadata.objects.IGenericElement

ATTRIBUTE, BUSINESS_OBJECT, BUSINESS_OBJECT_GROUP, FUNCTION, RELATION

Method Summary

Modifier and Type	Method and Description
Set<IFunctionException>	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.
IParameter	getParameter(String parameterUniqueName) Given a parameter name - returns an IParamter interface for that function parameter.
List<IParameter>	getParameters() Returns a List of all the function's parameters.
List<IParameter>	getParameters(int parameterDirection) Returns a List of in/out/inAndOut function's parameters according to the paremeterDirection parameter.

Methods inherited from interface com.sapportals.connector.metadata.objects.IGenericElement

getDescription, getElementType, getMetaType, getName, getNamespace, getUniqueName, retrieveTerm

Methods inherited from interface com.sapportals.connector.IConnectorObject

retrieveConnection

Field Detail

SEND_FUNCTION

static final int SEND_FUNCTION

Costant indicates this EIS function has input parameters only

See Also:

Constant Field Values

RECIEVE_FUNCTION

static final int RECIEVE_FUNCTION

Costant indicates this EIS function has output parameter only

See Also:

Constant Field Values

SEND_RECIEVE_FUNCTION

static final int SEND_RECIEVE_FUNCTION

Costant indicates this EIS function has input and output parameters

See Also:

Constant Field Values

UNKNOWN_TYPE_FUNCTION

static final int UNKNOWN_TYPE_FUNCTION

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

See Also:

Constant Field Values

Method Detail

getExceptions

Set<IFunctionException> getExceptions()
                               throws ConnectorException

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

Returns:

a set of exceptions.

Throws:

ConnectorException - if connector is failed

See Also:

IFunctionException

getParameters

List<IParameter> 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

Throws:

ConnectorException - if connector is failed

See Also:

IParameter

getParameters

List<IParameter> getParameters(int parameterDirection)
                        throws ConnectorException

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

Parameters:

parameterDirection - is a parameter of direction

Returns:

a list of IParamter interface

Throws:

ConnectorException - if connector is failed

See Also:

IParameter

getParameter

IParameter getParameter(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

Throws:

ParameterNotFoundException - if parameter not found

ConnectorException - if connector is failed

See Also:

IParameter

getFunctionType

int getFunctionType()

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

Returns:

the function type