org.teiid.connector.metadata.runtime
Interface Parameter

All Superinterfaces:

MetadataObject, TypeModel

public interface Parameter
extends MetadataObject, TypeModel

Represents a procedure parameter in the runtime metadata.

Field Summary

static int	IN
static int	INOUT
static int	OUT
static int	RESULT_SET
static int	RETURN

Fields inherited from interface org.teiid.connector.metadata.runtime.TypeModel

NOT_NULLABLE, NOT_SEARCHABLE, NULLABLE, NULLABLE_UNKNOWN, SEARCHABLE, SEARCHABLE_COMPARE, SEARCHABLE_LIKE

Method Summary

java.util.List<Element>	getChildren()
int	getDirection() Get direction of the parameter, as specified by direction constants.
int	getIndex() Index of the parameter in the procedure.
Procedure	getParent() Get the parent

Methods inherited from interface org.teiid.connector.metadata.runtime.MetadataObject

getFullName, getName, getNameInSource, getProperties

Methods inherited from interface org.teiid.connector.metadata.runtime.TypeModel

getDefaultValue, getJavaType, getLength, getModeledBaseType, getModeledPrimitiveType, getModeledType, getNullability, getPrecision, getScale

Field Detail

IN

static final int IN

See Also:

Constant Field Values

OUT

static final int OUT

See Also:

Constant Field Values

INOUT

static final int INOUT

See Also:

Constant Field Values

RETURN

static final int RETURN

See Also:

Constant Field Values

RESULT_SET

static final int RESULT_SET

See Also:

Constant Field Values

Method Detail

getIndex

int getIndex()
             throws ConnectorException

Index of the parameter in the procedure. If the parameter has no index, then the index will be returned as -1.

Returns:

Index of the parameter

Throws:

ConnectorException

getDirection

int getDirection()
                 throws ConnectorException

Get direction of the parameter, as specified by direction constants.

Returns:

Direction constant

Throws:

ConnectorException

See Also:

IN, OUT, INOUT, RETURN, RESULT_SET

getParent

Procedure getParent()
                    throws ConnectorException

Get the parent

Returns:

Parent

Throws:

ConnectorException

getChildren

java.util.List<Element> getChildren()
                                    throws ConnectorException

Throws:

ConnectorException