public class DataSetParameter
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private boolean |
append
Corresponds calling-side APPEND option.
|
private handle |
dataset
Reference of the wrapped dataset.
|
private DatasetWrapper |
datasetWrapper
Calling- or called-side result set (for remote parameters).
|
private ParameterOption |
mode
Parameter passing mode BY-VALUE, BIND or BY-REFERENCE option.
|
private DataSet |
originalDataSet
The original dataset passed as an argument.
|
private int |
parameterIndex
1-based index of the dataset parameter (in declaration of the function).
|
private boolean |
remoteParameter
Determines if this is a remote (passed to appserver) parameter.
|
Constructor and Description |
---|
DataSetParameter(DataSet dataset)
Create an instance using a dataset reference.
|
DataSetParameter(DataSet dataset,
boolean append)
Create an instance using a dataset reference.
|
DataSetParameter(DataSet dataset,
boolean append,
ParameterOption mode)
Create an instance using a dataset reference.
|
DataSetParameter(DataSetParameter dataset)
Create an instance using a dataset reference.
|
DataSetParameter(DatasetWrapper wrapper)
Create a new parameter for the REMOTE dataset.
|
DataSetParameter(handle dsHandle)
Create an instance using a dataset handle.
|
DataSetParameter(handle dsHandle,
boolean append)
Create an instance using a dataset handle.
|
DataSetParameter(handle dsHandle,
boolean append,
ParameterOption mode)
Create an instance using a dataset handle.
|
Modifier and Type | Method and Description |
---|---|
void |
createDataSet(DatasetWrapper wrapper)
Create a new DATASET resource from the specified wrapper, and save it in the
dataset
handle. |
handle |
get()
Obtain the
DataSet handle. |
DataSet |
getDataset()
Returns the unwrapped dataset instance.
|
handle |
getDatasetHandle()
Returns the wrapped dataset instance.
|
DatasetWrapper |
getDatasetWrapper() |
DataSet |
getOriginalDataSet()
Get the original dataset, as passed by the caller.
|
int |
getParameterIndex()
Get 1-based index of the dataset parameter (in declaration of the function).
|
boolean |
isAppend()
Checks whether this parameter was passed with
APPEND option. |
boolean |
isBind()
Checks whether this parameter was passed with
BIND option. |
boolean |
isByReference()
Checks whether this parameter was passed with
BY-REFERENCE option. |
boolean |
isByValue()
Checks whether this parameter was passed with
BY-VALUE option. |
boolean |
isRemoteParameter()
Checks whether this is a remote parameter.
|
void |
setDatasetWrapper(DatasetWrapper datasetWrapper) |
void |
setParameterIndex(int parameterIndex)
Set 1-based index of the dataset parameter (in declaration of the function).
|
java.lang.String |
toString()
Get a string representation of this dataset.
|
private final handle dataset
private final boolean append
private final ParameterOption mode
private boolean remoteParameter
private DatasetWrapper datasetWrapper
(equivalent of TableWrapper resultSet
in TableParameter
).
private int parameterIndex
0
when
not defined.private DataSet originalDataSet
public DataSetParameter(DatasetWrapper wrapper)
wrapper
- The REMOTE dataset.public DataSetParameter(DataSetParameter dataset)
dataset
- Reference of the wrapped dataset.public DataSetParameter(DataSet dataset)
dataset
- Reference of the wrapped dataset.public DataSetParameter(DataSet dataset, boolean append)
dataset
- Reference of the wrapped dataset.append
- Determines if APPEND option was specified on the calling side.public DataSetParameter(DataSet dataset, boolean append, ParameterOption mode)
dataset
- Reference of the wrapped dataset.append
- Determines if APPEND option was specified on the calling side.mode
- Parameter passing mode BY-VALUE, BIND or BY-REFERENCE option.public DataSetParameter(handle dsHandle)
dsHandle
- Handle to the wrapped dataset.public DataSetParameter(handle dsHandle, boolean append)
dsHandle
- Handle to the wrapped dataset.append
- Determines if APPEND option was specified on the calling side.public DataSetParameter(handle dsHandle, boolean append, ParameterOption mode)
dsHandle
- Handle to the wrapped dataset.append
- Determines if APPEND option was specified on the calling side.mode
- Parameter passing mode BY-VALUE, BIND or BY-REFERENCE option.public handle get()
DataSet
handle.public DataSet getOriginalDataSet()
originalDataSet
.public DataSet getDataset()
public handle getDatasetHandle()
public boolean isAppend()
APPEND
option.true
if this parameter was passed with APPEND
option.public boolean isByReference()
BY-REFERENCE
option.true
if this parameter was passed with BY-REFERENCE
option.public boolean isByValue()
BY-VALUE
option.true
if this parameter was passed with BY-VALUE
option.public boolean isBind()
BIND
option.true
if this parameter was passed with BIND
option.public boolean isRemoteParameter()
true
if this is a remote parameter, false
if this is a local
parameter.public DatasetWrapper getDatasetWrapper()
public void setDatasetWrapper(DatasetWrapper datasetWrapper)
public int getParameterIndex()
0
when not defined.public void setParameterIndex(int parameterIndex)
parameterIndex
- 1-based index of the dataset parameter.public void createDataSet(DatasetWrapper wrapper)
dataset
handle.wrapper
- The dataset from the remote side.public java.lang.String toString()
toString
in class java.lang.Object