public class TableParameter
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private boolean |
append
Corresponds calling-side APPEND option.
|
private ParameterOption |
mode
Parameter passing mode BY-VALUE, BIND or BY-REFERENCE option.
|
private int |
parameterIndex
1-based index of the table parameter (in declaration of the function).
|
private boolean |
remoteParameter
Determines if this is a remote (passed to appserver) parameter.
|
private TableWrapper |
resultSet
Calling- or called-side result set (for remote parameters).
|
private Temporary |
table
Buffer of the wrapped table.
|
private handle |
tableHandle
Table handle.
|
Constructor and Description |
---|
TableParameter(handle tableHandle)
Create an instance using a table handle.
|
TableParameter(handle tableHandle,
boolean append)
Create an instance using a table handle.
|
TableParameter(handle tableHandle,
boolean append,
ParameterOption mode)
Create an instance using a table handle.
|
TableParameter(TableWrapper resultSet,
boolean append)
Create an instance using a result set (for remote parameters).
|
TableParameter(TableWrapper resultSet,
boolean append,
ParameterOption mode)
Create an instance using a result set (for remote parameters).
|
TableParameter(Temporary table)
Create an instance using a buffer.
|
TableParameter(Temporary table,
boolean append)
Create an instance using a buffer.
|
TableParameter(Temporary table,
boolean append,
ParameterOption mode)
Create an instance using a buffer.
|
Modifier and Type | Method and Description |
---|---|
int |
getParameterIndex()
Get 1-based index of the table parameter (in declaration of the function).
|
ParameterOption |
getParameterMode()
Get the parameter passing mode for this argument.
|
TableWrapper |
getResultSet()
Get result set (for remote parameters).
|
Temporary |
getTable()
Get the buffer of the wrapped table.
|
handle |
getTableHandle()
Get the handle which references the wrapped table.
|
boolean |
isAppend()
Determines if the APPEND option was specified on the calling side.
|
boolean |
isBind()
Determines if the
BIND option was specified on the calling side. |
boolean |
isByReference()
Determines if the
BY-REFERENCE option was specified on the calling side. |
boolean |
isByValue()
Determines if the
BY-VALUE option was specified on the calling side. |
boolean |
isRemoteParameter()
Determines if this is a remote parameter.
|
boolean |
isValid()
Return
true if the table parameter is valid. |
void |
setParameterIndex(int parameterIndex)
Set 1-based index of the table parameter (in declaration of the function).
|
void |
setResultSet(TableWrapper resultSet)
Set result set (for remote parameters).
|
void |
setTable(Temporary table)
Set the parameter's table.
|
private Temporary table
private final handle tableHandle
private final boolean append
private final ParameterOption mode
private TableWrapper resultSet
private boolean remoteParameter
private int parameterIndex
0
if it is not defined.public TableParameter(Temporary table)
table
- Buffer of the wrapped table.public TableParameter(Temporary table, boolean append)
table
- Buffer of the wrapped table.append
- Determines if APPEND option was specified on the calling side.public TableParameter(Temporary table, boolean append, ParameterOption mode)
table
- Buffer of the wrapped table.append
- Determines if APPEND option was specified on the calling side.mode
- Parameter passing mode BY-VALUE, BIND or BY-REFERENCE option.public TableParameter(handle tableHandle)
tableHandle
- Handle to the wrapped table.public TableParameter(handle tableHandle, boolean append)
tableHandle
- Handle to the wrapped table.append
- Determines if APPEND option was specified on the calling side.public TableParameter(handle tableHandle, boolean append, ParameterOption mode)
tableHandle
- Handle to the wrapped table.append
- Determines if APPEND option was specified on the calling side.mode
- Parameter passing mode BY-VALUE, BIND or BY-REFERENCE option.public TableParameter(TableWrapper resultSet, boolean append)
resultSet
- Result set containing input data.append
- Determines if APPEND option was specified on the calling side.public TableParameter(TableWrapper resultSet, boolean append, ParameterOption mode)
resultSet
- Result set containing input data.append
- Determines if APPEND option was specified on the calling side.mode
- Parameter passing mode BY-VALUE, BIND or BY-REFERENCE option.public boolean isRemoteParameter()
true
if this is a remote parameter, false
if this is a
local parameter.public TableWrapper getResultSet()
public void setResultSet(TableWrapper resultSet)
resultSet
- Result set, normally containing output data.public handle getTableHandle()
public void setTable(Temporary table)
table
- The tablepublic Temporary getTable()
public boolean isAppend()
true
if the APPEND option was specified on the calling side.public boolean isByValue()
BY-VALUE
option was specified on the calling side.true
if the BY-VALUE
option was specified on the calling side.public boolean isBind()
BIND
option was specified on the calling side.true
if the BIND
option was specified on the calling side.public boolean isByReference()
BY-REFERENCE
option was specified on the calling side.true
if the BY-REFERENCE
option was specified on the calling side.public ParameterOption getParameterMode()
mode
.public int getParameterIndex()
0
if it is not defined.public void setParameterIndex(int parameterIndex)
parameterIndex
- 1-based index of the table parameter.public boolean isValid()
true
if the table parameter is valid. It can be invalid, say, if an unknown table
handle has been assigned to it.true
if the table parameter is valid.