com.sapportals.connector.metadata.functions
Interface IParameter

All Superinterfaces:

ISOAPSerializable

public interface IParameter

extends ISOAPSerializable

TThis interface exposes metadata for a parameter for an EIS function

Version:

1.0

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

java.lang.Object	getDefaultValue() Returns the default value for this parameter.
java.lang.String	getDescription() Returns the description of this parameter.
int	getDirection() Returns the direction of this parameter.
java.lang.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.
java.lang.String	getUniqueName() Returns the unique name of the parameter.
java.util.Set	getValidValues() Returns a set of valid values for this parameter.
boolean	hasDefaultValue() Returns whether the parameter has a default value.
int	isOptional() Returns whether the parameter is optional.
IFunction	retrieveParentFunction() Returns the function composing this parameter.
java.lang.String	retrieveTerm() Returns the term describing the parameter, for example "Parameter"

Field Detail

NECESSITY_UNKNOWN

public static final int NECESSITY_UNKNOWN

Constant indicating this parameter has unknown necessity

NECESSITY_MANDATORY

public static final int NECESSITY_MANDATORY

Constant indicating this parameter is mandatory

NECESSITY_OPTIONAL

public static final int NECESSITY_OPTIONAL

Constant indicating this parameter is optional

DIRECTION_UNKNOWN

public static final int DIRECTION_UNKNOWN

Constant indicating this parameter direction is unknown

DIRECTION_IN

public static final int DIRECTION_IN

Constant indicating this is an input parameter

DIRECTION_OUT

public static final int DIRECTION_OUT

Constant indicating this is an output parameter

DIRECTION_INOUT

public static final int DIRECTION_INOUT

Constant indicating this is an input-output parameter

OWNER_PROVIDER

public static final int OWNER_PROVIDER

Constant indicating the EIS is the owner of the parameter

OWNER_CONSUMER

public static final int OWNER_CONSUMER

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

Method Detail

isOptional

public int isOptional()

Returns whether the parameter is optional.

Returns:

boolean - whether the parameter is optional.

hasDefaultValue

public boolean hasDefaultValue()

Returns whether the parameter has a default value.

Returns:

boolean - whether the parameter has a default value.

getDefaultValue

public java.lang.Object getDefaultValue()
                                 throws ConnectorException

Returns the default value for this parameter.

Returns:

Object - the default value for this parameter.

getValidValues

public java.util.Set getValidValues()
                             throws ConnectorException

Returns a set of valid values for this parameter.

Returns:

Object - the set of valid values for this parameter.

getDirection

public int getDirection()

Returns the direction of this parameter.

Returns:

the direction of this parameter: DIRECTION_IN DIRECTION_OUT DIRECTION_INOUT DIRECTION_UNKNOWN

retrieveParentFunction

public IFunction retrieveParentFunction()

Returns the function composing this parameter.

Returns:

IFunction interface of the parent function.

See Also:

IFunction

getStructure

public IStructure getStructure()
                        throws ConnectorException

Returns the metadata describing the structure of this parameter.

Returns:

IStructure - the metadata describing the structure of this parameter.

See Also:

IStructure

getDescription

public java.lang.String getDescription()

Returns the description of this parameter.

Returns:

String - the description of this parameter.

getName

public java.lang.String getName()

Returns the name of this parameter.

Returns:

String - the name of this parameter.

getOwner

public int getOwner()

returns the owner of the parameter

Returns:

integer indicating the owner of the parameter: OWNER_PROVIDER OWNER_CONSUMER

getUniqueName

public java.lang.String getUniqueName()

Returns the unique name of the parameter.

Returns:

The parameter unique name.

retrieveTerm

public java.lang.String retrieveTerm()

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

Returns:

The parameter term