StoredProcedureParameter (Denodo Virtual DataPort 6.0.16 API)

java.lang.Object
- com.denodo.vdb.engine.storedprocedure.StoredProcedureParameter

All Implemented Interfaces:

com.denodo.vdb.catalog.view.EquivalenceVerifiable
```
public class StoredProcedureParameter
extends Object
implements com.denodo.vdb.catalog.view.EquivalenceVerifiable
```
This class represents a parameter of a stored procedure.

Field Summary

Fields
Modifier and Type Field and Description

static int DIRECTION_IN
Input parameter.

static int DIRECTION_INOUT
Input/output parameter.

static int DIRECTION_OUT
Output parameter.

Fields
Modifier and Type	Field and Description
`static int`	`DIRECTION_IN` Input parameter.
`static int`	`DIRECTION_INOUT` Input/output parameter.
`static int`	`DIRECTION_OUT` Output parameter.

Constructor Summary

Constructors
Constructor and Description
`StoredProcedureParameter(String name, int type, int direction)` Creates a new StoredProcedureParameter.
`StoredProcedureParameter(String name, int type, int direction, boolean nullable)` Creates a new StoredProcedureParameter.
`StoredProcedureParameter(String name, int type, int direction, boolean nullable, StoredProcedureParameter[] columns)` Creates a new StoredProcedureParameter.
`StoredProcedureParameter(String name, int type, int direction, StoredProcedureParameter[] columns)` Creates a new StoredProcedureParameter.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equivalent(com.denodo.vdb.catalog.view.EquivalenceVerifiable obj)`
`StoredProcedureParameter[]`	`getColumns()` Obtains the columns of the parameter.
`int`	`getDirection()` Obtains the direction of the parameter, indicating if the value must be provided or it is generated by the procedure.
`String`	`getName()` Obtains the name of the parameter.
`int`	`getType()` Obtains the type of the parameter.
`boolean`	`isNullable()` Determines if the parameter is nullable.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DIRECTION_IN
```
public static final int DIRECTION_IN
```
    Input parameter. The parameter must be provided to the procedure.
    
    See Also:
    Constant Field Values
  - DIRECTION_OUT
```
public static final int DIRECTION_OUT
```
    Output parameter. The value is generated by the stored procedure.
    
    See Also:
    Constant Field Values
  - DIRECTION_INOUT
```
public static final int DIRECTION_INOUT
```
    Input/output parameter. The parameter value must be provided to the procedure, which also can modify it.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - StoredProcedureParameter
```
public StoredProcedureParameter(String name,
                        int type,
                        int direction)
```
    Creates a new StoredProcedureParameter.
    
    Parameters:
    name - the name of the parameter.
    type - the type of the parameter, from Types.
    direction - the direction of the parameter, indicating if the value must be provided or it is generated by the procedure. Should be one of these: DIRECTION_IN, DIRECTION_OUT or DIRECTION_INOUT
  - StoredProcedureParameter
```
public StoredProcedureParameter(String name,
                        int type,
                        int direction,
                        boolean nullable)
```
    Creates a new StoredProcedureParameter.
    
    Parameters:
    name - the name of the parameter.
    type - the type of the parameter, from Types.
    direction - the direction of the parameter, indicating if the value must be provided or it is generated by the procedure. Should be one of these: DIRECTION_IN, DIRECTION_OUT or DIRECTION_INOUT
    nullable - indicates if a NULL value can be specified for this parameter
  - StoredProcedureParameter
```
public StoredProcedureParameter(String name,
                        int type,
                        int direction,
                        StoredProcedureParameter[] columns)
```
    Creates a new StoredProcedureParameter.
    
    Parameters:
    name - the name of the parameter.
    type - the type of the parameter, from Types.
    direction - the direction of the parameter, indicating if the value must be provided or it is generated by the procedure. Should be one of these: DIRECTION_IN, DIRECTION_OUT or DIRECTION_INOUT
    columns - if the parameter is register or array, specifies its subfields.
  - StoredProcedureParameter
```
public StoredProcedureParameter(String name,
                        int type,
                        int direction,
                        boolean nullable,
                        StoredProcedureParameter[] columns)
```
    Creates a new StoredProcedureParameter.
    
    Parameters:
    name - the name of the parameter.
    type - the type of the parameter, from Types.
    direction - the direction of the parameter, indicating if the value must be provided or it is generated by the procedure. Should be one of these: DIRECTION_IN, DIRECTION_OUT or DIRECTION_INOUT
    nullable - indicates if a NULL value can be specified for this parameter
    columns - if the parameter is register or array, specifies its subfields.
- Method Detail
  - getColumns
```
public StoredProcedureParameter[] getColumns()
```
    Obtains the columns of the parameter.
    
    Returns:
    the columns of the parameter.
  - getDirection
```
public int getDirection()
```
    Obtains the direction of the parameter, indicating if the value must be provided or it is generated by the procedure.
    
    Returns:
    one of these values: DIRECTION_IN, DIRECTION_OUT or DIRECTION_INOUT
  - getName
```
public String getName()
```
    Obtains the name of the parameter.
    
    Returns:
    the name of the parameter.
  - getType
```
public int getType()
```
    Obtains the type of the parameter.
    
    Returns:
    a value from Types
  - isNullable
```
public boolean isNullable()
```
    Determines if the parameter is nullable.
    
    Returns:
    true if the parameter is nullable, false otherwise.
    Since:
    
    4.6
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    Object.toString()
  - equivalent
```
public boolean equivalent(com.denodo.vdb.catalog.view.EquivalenceVerifiable obj)
```
    Specified by:
    
    equivalent in interface com.denodo.vdb.catalog.view.EquivalenceVerifiable

Class StoredProcedureParameter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIRECTION_IN

DIRECTION_OUT

DIRECTION_INOUT

Constructor Detail

StoredProcedureParameter

StoredProcedureParameter

StoredProcedureParameter

StoredProcedureParameter

Method Detail

getColumns

getDirection

getName

getType

isNullable

toString

equivalent