org.firebirdsql.jdbc
Class FBProcedureCall
java.lang.Object
org.firebirdsql.jdbc.FBProcedureCall
- Cloneable
public class FBProcedureCall
extends java.lang.Object
implements Cloneable
Represents procedure call.
OLD_CALLABLE_STATEMENT_COMPATIBILITY
public static final boolean OLD_CALLABLE_STATEMENT_COMPATIBILITY
true
if the old callable statement compatibility mode should
be used, otherwise - false
. Current value - true
.
addInputParam
public void addInputParam(FBProcedureParam param)
Add an input parameter to this procedure call.
param
- The parameter to be added
addOutputParam
public void addOutputParam(FBProcedureParam param)
Add an output parameter to this procedure call.
param
- The parameter to be added
addParam
public FBProcedureParam addParam(int position,
String param)
Add call parameter. This method adds new parameter to the procedure call
and tries to automatically place the parameter into the right collection
if it contains a hint whether it is input or output parameter.
position
- position of the parameter in the procedure call.param
- contents of the parameter.
clone
public Object clone()
equals
public boolean equals(Object obj)
Check if obj
is equal to this instance.
true
iff obj
is instance of this class
representing the same procedure with the same parameters.
getInputParam
public FBProcedureParam getInputParam(int index)
Get input parameter by the specified index.
index
- index for which parameter has to be returned, first
index is 1
getInputParams
public List getInputParams()
Get the list of input parameters for this procecedure call.
- A list of all input parameters
getName
public String getName()
Get the name of the procedure to be called.
getOutputParam
public FBProcedureParam getOutputParam(int index)
Get the output parameter at the specified index.
index
- The index of the parameter, first index is 1
- The parameter at the given index
getOutputParams
public List getOutputParams()
Get a list of output parameters for this procedure call.
- A list of all output parameters
getSQL
public String getSQL(boolean select)
throws FBSQLException
Get native SQL for the specified procedure call.
- native SQL that can be executed by the database server.
mapOutParamIndexToPosition
public int mapOutParamIndexToPosition(int index)
throws FBSQLException
Map output parameter index to a column number of corresponding result
set.
- mapped column number or
index
if no output parameter
with the specified index found (assuming that OLD_CALLABLE_STATEMENT_COMPATIBILITY
constant is set to true
, otherwise throws exception).
mapOutParamIndexToPosition
public int mapOutParamIndexToPosition(int index,
boolean compatibilityMode)
throws FBSQLException
Map output parameter index to a column number of corresponding result
set.
index
- index to map.compatibilityMode
- true
if we should run in old
compatibility mode.
- mapped column number or
index
if no output parameter
with the specified index found and compatibilityMode
is set.
FBSQLException
- if compatibility mode is switched off and no
parameter was found.
registerOutParam
public void registerOutParam(int index,
int type)
throws SQLException
Register output parameter. This method marks parameter with the specified
index as output. Parameters marked as output cannot be used as input
parameters.
index
- index of the parameter to mark as output.type
- SQL type of the parameter.
setName
public void setName(String name)
Set the name of the procedure to be called.
name
- The name of the procedure
Copyright B) 2001 David Jencks and other authors. All rights reserved.