org.firebirdsql.jdbc

Class FBProcedureParam

Implemented Interfaces:
Cloneable

public class FBProcedureParam
extends java.lang.Object
implements Cloneable

Represents procedure call parameter.

Constructor Summary

FBProcedureParam()
FBProcedureParam(int position, String paramValue)
Create a new FBProcedureParam instance.

Method Summary

Object
clone()
boolean
equals(Object obj)
int
getIndex()
String
getParamValue()
Get the variable value of this parameter
int
getPosition()
Get the position of this parameter
int
getType()
Get the SQL type of this paramater.
Object
getValue()
Set the value for this parameter
boolean
isParam()
Check if this parameter is a variable input parameter
boolean
isValueSet()
Check if the value of this parameter has been set
void
setIndex(int index)
void
setType(int type)
Set the SQL type of this parameter
void
setValue(Object value)
Set the variable value of this parameter

Constructor Details

FBProcedureParam

public FBProcedureParam()

FBProcedureParam

public FBProcedureParam(int position,
                        String paramValue)
Create a new FBProcedureParam instance.
Parameters:
position - The position at which this parameter is situated in the call
paramValue - The value for this parameter

Method Details

clone

public Object clone()

equals

public boolean equals(Object obj)

getIndex

public int getIndex()

getParamValue

public String getParamValue()
Get the variable value of this parameter
Returns:
The parameter value

getPosition

public int getPosition()
Get the position of this parameter
Returns:
The index of this parameter (first index is 1)

getType

public int getType()
Get the SQL type of this paramater.
Returns:
The SQL type of this parameter

getValue

public Object getValue()
Set the value for this parameter

isParam

public boolean isParam()
Check if this parameter is a variable input parameter
Returns:
true if this is an input parameter, false otherwise

isValueSet

public boolean isValueSet()
Check if the value of this parameter has been set
Returns:
true if the value has been set, false otherwise

setIndex

public void setIndex(int index)

setType

public void setType(int type)
Set the SQL type of this parameter
Parameters:
type - The SQL type of this parameter

setValue

public void setValue(Object value)
            throws SQLException
Set the variable value of this parameter
Parameters:
value - The value to be set

Copyright B) 2001 David Jencks and other authors. All rights reserved.