com.metamatrix.metadata.runtime.api
Interface ProcedureParameter

All Known Implementing Classes:

BasicProcedureParameter

public interface ProcedureParameter

Instances of this interface represent Parameters for a Procedure. A Procedure can have various types of parameters. The types are as follows:

• IN - Input parameter
• OUT - Output parameter
• INOUT - Input-Output parameter
• RETURN VALUE - a return value
• RESULT SET(S) - one or more nested result sets

Method Summary

DataType	getDataType() Returns the DataType this parameter will be represented as.
java.lang.String	getDefaultValue() Returns the default value of parameter if it is optional.
java.lang.String	getName()
short	getParameterType() Return short indicating the type of parameter.
int	getPosition() Returns the order of parameter in relation to the other parameters that are of the same type for its procedure.
ProcedureID	getProcID() Returns the procID.
int	getResultSetPosition()
boolean	isOptional() Returns a boolean indicating if this parameter is optional.

Method Detail

getDataType

DataType getDataType()

Returns the DataType this parameter will be represented as.

Returns:

DataType

getParameterType

short getParameterType()

Return short indicating the type of parameter.

Returns:

short

See Also:

MetadataConstants.PARAMETER_TYPES

isOptional

boolean isOptional()

Returns a boolean indicating if this parameter is optional.

Returns:

boolean true when the parameter is optional

getPosition

int getPosition()

Returns the order of parameter in relation to the other parameters that are of the same type for its procedure.

Returns:

int postion

getResultSetPosition

int getResultSetPosition()

getName

java.lang.String getName()

getDefaultValue

java.lang.String getDefaultValue()

Returns the default value of parameter if it is optional.

Returns:

int postion

getProcID

ProcedureID getProcID()

Returns the procID.

Returns:

ProcedureID