com.sapportals.connector.metadata.functions

Interface IParameter

All Superinterfaces:

ISOAPSerializable, IStructureValue

public interface IParameter
extends ISOAPSerializable, IStructureValue

TThis interface exposes metadata for a parameter for an EIS function

Field Summary

static int	DIRECTION_IN Constant indicating this is an input parameter
static int	DIRECTION_INOUT Constant indicating this is an input-output parameter
static int	DIRECTION_OUT Constant indicating this is an output parameter
static int	DIRECTION_UNKNOWN Constant indicating this parameter direction is unknown
static int	NECESSITY_MANDATORY Constant indicating this parameter is mandatory
static int	NECESSITY_OPTIONAL Constant indicating this parameter is optional
static int	NECESSITY_UNKNOWN Constant indicating this parameter has unknown necessity
static int	OWNER_CONSUMER Constant indicating the client calling the EIS function is the owner of the parameter
static int	OWNER_PROVIDER Constant indicating the EIS is the owner of the parameter

Method Summary

String	getDescription() Returns the description of this parameter.
int	getDirection() Returns the direction of this parameter.
String	getName() Returns the name of this parameter.
int	getOwner() returns the owner of the parameter
IStructure	getStructure() Returns the metadata describing the structure of this parameter.
String	getUniqueName() Returns the unique name of the parameter.
IFunction	retrieveParentFunction() Returns the function composing this parameter.
String	retrieveTerm() Returns the term describing the parameter, for example "Parameter"

Methods inherited from interface com.sapportals.connector.metadata.structures.IStructureValue

getDefaultValue, getValidValues, hasDefaultValue, isOptional

Field Detail

NECESSITY_UNKNOWN

static final int NECESSITY_UNKNOWN

Constant indicating this parameter has unknown necessity

See Also:

Constant Field Values

NECESSITY_MANDATORY

static final int NECESSITY_MANDATORY

Constant indicating this parameter is mandatory

See Also:

Constant Field Values

NECESSITY_OPTIONAL

static final int NECESSITY_OPTIONAL

Constant indicating this parameter is optional

See Also:

Constant Field Values

DIRECTION_UNKNOWN

static final int DIRECTION_UNKNOWN

Constant indicating this parameter direction is unknown

See Also:

Constant Field Values

DIRECTION_IN

static final int DIRECTION_IN

Constant indicating this is an input parameter

See Also:

Constant Field Values

DIRECTION_OUT

static final int DIRECTION_OUT

Constant indicating this is an output parameter

See Also:

Constant Field Values

DIRECTION_INOUT

static final int DIRECTION_INOUT

Constant indicating this is an input-output parameter

See Also:

Constant Field Values

OWNER_PROVIDER

static final int OWNER_PROVIDER

Constant indicating the EIS is the owner of the parameter

See Also:

Constant Field Values

OWNER_CONSUMER

static final int OWNER_CONSUMER

Constant indicating the client calling the EIS function is the owner of the parameter

See Also:

Constant Field Values

Method Detail

getDirection

int getDirection()

Returns the direction of this parameter.

Returns:

the direction of this parameter: DIRECTION_IN DIRECTION_OUT DIRECTION_INOUT DIRECTION_UNKNOWN

retrieveParentFunction

IFunction retrieveParentFunction()

Returns the function composing this parameter.

Returns:

IFunction interface of the parent function.

See Also:

IFunction

getStructure

IStructure getStructure()
                        throws ConnectorException

Returns the metadata describing the structure of this parameter.

Returns:

IStructure - the metadata describing the structure of this parameter.

Throws:

ConnectorException

See Also:

IStructure

getDescription

String getDescription()

Returns the description of this parameter.

Returns:

String - the description of this parameter.

getName

String getName()

Returns the name of this parameter.

Returns:

String - the name of this parameter.

getOwner

int getOwner()

returns the owner of the parameter

Returns:

integer indicating the owner of the parameter: OWNER_PROVIDER OWNER_CONSUMER

getUniqueName

String getUniqueName()

Returns the unique name of the parameter.

Returns:

The parameter unique name.

retrieveTerm

String retrieveTerm()

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

Returns:

The parameter term

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] FRAMEWORK-EXT	[sap.com] tc/conn/connectorframeworkdeprecated	default	EP-CON-CF
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/connectivityfw/api	api	EP-PIN
[sap.com] FRAMEWORK-EXT	[sap.com] tc/conn/connectorframeworkdeprecated	-	EP-CON-CF