public interface DataSourceInterface
DataSource
.Modifier and Type | Method and Description |
---|---|
logical |
addSourceBuffer(handle buf,
java.lang.String keyFields)
Adds a database buffer to a dynamic data-source object at run time.
|
logical |
addSourceBuffer(handle buf,
Text keyFields)
Adds a database buffer to a dynamic data-source object at run time.
|
handle |
getDatasetBuffer()
Gets the handle to the source buffer associated with this
DataSource . |
character |
getFillWhereString()
Gets the current
WHERE expression for a data-source query, beginning with the
keyword WHERE , and not including the prior FOR EACH phrase of an
OPEN QUERY statement. |
logical |
getMergeByField()
Checks whether the changes on a field-by-field basis will be merged when saving changes from
a
DataSet temp-table buffer to the associated data source using the
SAVE-ROW-CHANGES() method. |
rowid |
getNextRowid()
Gets the
ROWID of the data source row at which the next FILL operation
should start. |
rowid |
getNextRowid(character buffName)
Gets the
ROWID of the data source row at which the next FILL operation
should start. |
rowid |
getNextRowid(long buffNo)
Gets the
ROWID of the data source row at which the next FILL operation
should start. |
rowid |
getNextRowid(NumberType buffNo)
Gets the
ROWID of the data source row at which the next FILL operation
should start. |
rowid |
getNextRowid(java.lang.String buffName)
Gets the
ROWID of the data source row at which the next FILL operation
should start. |
integer |
getNumSourceBuffers()
Obtain the number of source buffers in this data-source object.
|
logical |
getPreferDataset()
Checks whether the modifications to the data currently in the data source are ignored when
saving changes from a
DataSet temp-table buffer to the associated data source using
the SAVE-ROW-CHANGES() method. |
character |
getPrivateData()
Get the
PRIVATE-DATA attribute of this handle. |
integer |
getRestartRow()
Gets the current position (absolute row number) for the
FILL query. |
rowid |
getRestartRowid()
Obtain the
ROWID of the data source row at which a FILL operation will
start. |
rowid |
getRestartRowid(long buffNum)
Obtain the
ROWID of the data source row at which a FILL operation will
start. |
rowid |
getRestartRowid(NumberType buffNum)
Obtain the
ROWID of the data source row at which a FILL operation will
start. |
rowid |
getRestartRowid(java.lang.String buffName)
Obtain the
ROWID of the data source row at which a FILL operation will
start. |
rowid |
getRestartRowid(Text buffName)
Obtain the
ROWID of the data source row at which a FILL operation will
start. |
character |
getSaveWhereString()
Obtain the
WHERE clause used to find the database buffer identified by the
buffName in a data-source object. |
character |
getSaveWhereString(long buffNum)
Obtain the
WHERE clause used to find the database buffer identified by the
buffName in a data-source object. |
character |
getSaveWhereString(NumberType buffNum)
Obtain the
WHERE clause used to find the database buffer identified by the
buffName in a data-source object. |
character |
getSaveWhereString(java.lang.String buffName)
Obtain the
WHERE clause used to find the database buffer identified by the
buffName in a data-source object. |
character |
getSaveWhereString(Text buffName)
Obtain the
WHERE clause used to find the database buffer identified by the
buffName in a data-source object. |
handle |
getSourceBuffer()
Gets the handle to the source buffer in the data-source object at the specified index
position.
|
handle |
getSourceBuffer(long bufIndex)
Gets the handle to the source buffer in the data-source object at the specified index
position.
|
handle |
getSourceBuffer(NumberType bufIndex)
Gets the handle to the source buffer in the data-source object at the specified index
position.
|
logical |
isIgnoreCurrentModified()
Checks whether the to ignores modifications to the data currently in the data source when
saving changes from a
DataSet temp-table buffer to the associated data source using
the Buffer.saveRowChanges() method. |
void |
setFillWhereString(java.lang.String pref)
Sets the current
WHERE expression for a data-source query, beginning with the
keyword WHERE , and not including the prior FOR EACH phrase of an
OPEN QUERY statement. |
void |
setFillWhereString(Text pref)
Sets the current
WHERE expression for a data-source query, beginning with the
keyword WHERE , and not including the prior FOR EACH phrase of an
OPEN QUERY statement. |
void |
setIgnoreCurrentModified(boolean on)
Sets whether the to ignores modifications to the data currently in the data source when
saving changes from a
DataSet temp-table buffer to the associated data source using
the Buffer.saveRowChanges() method. |
void |
setIgnoreCurrentModified(logical on)
Sets whether the to ignores modifications to the data currently in the data source when
saving changes from a
DataSet temp-table buffer to the associated data source using
the Buffer.saveRowChanges() method. |
void |
setMergeByField(boolean merge)
Configures whether the changes on a field-by-field basis will be merged when saving changes
from a
DataSet temp-table buffer to the associated data source using the
SAVE-ROW-CHANGES() method. |
void |
setMergeByField(logical merge)
Configures whether the changes on a field-by-field basis will be merged when saving changes
from a
DataSet temp-table buffer to the associated data source using the
SAVE-ROW-CHANGES() method. |
void |
setNextRowid(character buffName,
rowid row)
Sets the
ROWID of the data source row at which the next FILL operation
should start. |
void |
setNextRowid(long buffNo,
rowid row)
Sets the
ROWID of the data source row at which the next FILL operation
should start. |
void |
setNextRowid(NumberType buffNo,
rowid row)
Sets the
ROWID of the data source row at which the next FILL operation
should start. |
void |
setNextRowid(rowid row)
Sets the
ROWID of the data source row at which the next FILL operation
should start. |
void |
setNextRowid(java.lang.String buffName,
rowid row)
Sets the
ROWID of the data source row at which the next FILL operation
should start. |
void |
setPreferDataset(boolean pref)
Configures whether the modifications to the data currently in the data source are ignored
when saving changes from a
DataSet temp-table buffer to the associated data source
using the SAVE-ROW-CHANGES() method. |
void |
setPreferDataset(logical pref)
Configures whether the modifications to the data currently in the data source are ignored
when saving changes from a
DataSet temp-table buffer to the associated data source
using the SAVE-ROW-CHANGES() method. |
void |
setPrivateData(character data)
Set the
PRIVATE-DATA attribute of this handle. |
void |
setPrivateData(java.lang.String data)
Set the
PRIVATE-DATA attribute of this handle. |
void |
setRestartRow(long newRow)
Reposition the
FILL query to an absolute row number. |
void |
setRestartRow(NumberType newRow)
Reposition the
FILL query to an absolute row number. |
void |
setRestartRowid(long buffNum,
rowid row)
Configures the
ROWID of the data source row at which a FILL operation will
start. |
void |
setRestartRowid(NumberType buffNum,
rowid row)
Configures the
ROWID of the data source row at which a FILL operation will
start. |
void |
setRestartRowid(rowid row)
Configures the
ROWID of the data source row at which a FILL operation will
start. |
void |
setRestartRowid(java.lang.String buffName,
rowid row)
Configures the
ROWID of the data source row at which a FILL operation will
start. |
void |
setRestartRowid(Text buffName,
rowid row)
Configures the
ROWID of the data source row at which a FILL operation will
start. |
void |
setSaveWhereString(long buffNum,
java.lang.String val)
Configures the
SAVE-WHERE-STRING attribute. |
void |
setSaveWhereString(long buffNum,
Text val)
Configures the
SAVE-WHERE-STRING attribute. |
void |
setSaveWhereString(NumberType buffNum,
java.lang.String val)
Configures the
SAVE-WHERE-STRING attribute. |
void |
setSaveWhereString(NumberType buffNum,
Text val)
Configures the
SAVE-WHERE-STRING attribute. |
void |
setSaveWhereString(java.lang.String val)
Configures the
SAVE-WHERE-STRING attribute. |
void |
setSaveWhereString(java.lang.String buffName,
java.lang.String val)
Configures the
SAVE-WHERE-STRING attribute. |
void |
setSaveWhereString(java.lang.String buffName,
Text val)
Configures the
SAVE-WHERE-STRING attribute. |
void |
setSaveWhereString(Text val)
Configures the
SAVE-WHERE-STRING attribute. |
void |
setSaveWhereString(Text buffName,
java.lang.String val)
Configures the
SAVE-WHERE-STRING attribute. |
void |
setSaveWhereString(Text buffName,
Text val)
Configures the
SAVE-WHERE-STRING attribute. |
logical getPreferDataset()
DataSet
temp-table buffer to the associated data source using
the SAVE-ROW-CHANGES()
method. The default value is FALSE
.PREFER-DATASET
attribute, as described above.void setPreferDataset(logical pref)
DataSet
temp-table buffer to the associated data source
using the SAVE-ROW-CHANGES()
method.pref
- the new value of PREFER-DATASET
attribute, as described above.void setPreferDataset(boolean pref)
DataSet
temp-table buffer to the associated data source
using the SAVE-ROW-CHANGES()
method.pref
- the new value of PREFER-DATASET
attribute, as described above.character getFillWhereString()
WHERE
expression for a data-source query, beginning with the
keyword WHERE
, and not including the prior FOR EACH
phrase of an
OPEN QUERY
statement.FILL-WHERE-STRING
attribute, as described above.void setFillWhereString(java.lang.String pref)
WHERE
expression for a data-source query, beginning with the
keyword WHERE
, and not including the prior FOR EACH
phrase of an
OPEN QUERY
statement.pref
- The new value of the FILL-WHERE-STRING
attribute, as described above.void setFillWhereString(Text pref)
WHERE
expression for a data-source query, beginning with the
keyword WHERE
, and not including the prior FOR EACH
phrase of an
OPEN QUERY
statement.pref
- The new value of the FILL-WHERE-STRING
attribute, as described above.logical getMergeByField()
DataSet
temp-table buffer to the associated data source using the
SAVE-ROW-CHANGES()
method. The default value is TRUE
.true
if the changes are merged on save on a field-by-field basis.void setMergeByField(boolean merge)
DataSet
temp-table buffer to the associated data source using the
SAVE-ROW-CHANGES()
method.merge
- The new value for the MERGE-BY-FIELD
attribute.void setMergeByField(logical merge)
DataSet
temp-table buffer to the associated data source using the
SAVE-ROW-CHANGES()
method.merge
- The new value for the MERGE-BY-FIELD
attribute.rowid getNextRowid()
ROWID
of the data source row at which the next FILL
operation
should start. The attribute is set after each FILL
operation in a series of
FILL
operations to retrieve data source rows in batches.NEXT-ROWID
as described above.rowid getNextRowid(NumberType buffNo)
ROWID
of the data source row at which the next FILL
operation
should start. The attribute is set after each FILL
operation in a series of
FILL
operations to retrieve data source rows in batches.buffNo
- The sequence number of a buffer in the list of buffers for the data-source object.NEXT-ROWID
as described above.rowid getNextRowid(long buffNo)
ROWID
of the data source row at which the next FILL
operation
should start. The attribute is set after each FILL
operation in a series of
FILL
operations to retrieve data source rows in batches.buffNo
- the sequence number of a buffer in the list of buffers for the data-source object.NEXT-ROWID
as described above.rowid getNextRowid(java.lang.String buffName)
ROWID
of the data source row at which the next FILL
operation
should start. The attribute is set after each FILL
operation in a series of
FILL
operations to retrieve data source rows in batches.buffName
- The name of a buffer in the list of buffers for the data-source object.NEXT-ROWID
as described above.rowid getNextRowid(character buffName)
ROWID
of the data source row at which the next FILL
operation
should start. The attribute is set after each FILL
operation in a series of
FILL
operations to retrieve data source rows in batches.buffName
- The name of a buffer in the list of buffers for the data-source object.NEXT-ROWID
as described above.void setNextRowid(rowid row)
ROWID
of the data source row at which the next FILL
operation
should start. Typically, the value of this attribute is assigned to the
RESTART-ROWID
attribute before each FILL
operation.row
- The new value of code NEXT-ROWID
as described above.void setNextRowid(NumberType buffNo, rowid row)
ROWID
of the data source row at which the next FILL
operation
should start. Typically, the value of this attribute is assigned to the
RESTART-ROWID
attribute before each FILL
operation.buffNo
- the sequence number of a buffer in the list of buffers for the data-source object.row
- The new value of code NEXT-ROWID
as described above.void setNextRowid(long buffNo, rowid row)
ROWID
of the data source row at which the next FILL
operation
should start. Typically, the value of this attribute is assigned to the
RESTART-ROWID
attribute before each FILL
operation.buffNo
- the sequence number of a buffer in the list of buffers for the data-source object.row
- The new value of code NEXT-ROWID
as described above.void setNextRowid(java.lang.String buffName, rowid row)
ROWID
of the data source row at which the next FILL
operation
should start. Typically, the value of this attribute is assigned to the
RESTART-ROWID
attribute before each FILL
operation.buffName
- The name of a buffer in the list of buffers for the data-source object.row
- The new value of code NEXT-ROWID
as described above.void setNextRowid(character buffName, rowid row)
ROWID
of the data source row at which the next FILL
operation
should start. Typically, the value of this attribute is assigned to the
RESTART-ROWID
attribute before each FILL
operation.buffName
- The name of a buffer in the list of buffers for the data-source object.row
- The new value of code NEXT-ROWID
as described above.integer getNumSourceBuffers()
integer getRestartRow()
FILL
query.RESTART-ROW
attribute.void setRestartRow(long newRow)
FILL
query to an absolute row number.newRow
- The new row number to reposition the query.void setRestartRow(NumberType newRow)
FILL
query to an absolute row number.newRow
- The new row number to reposition the query.rowid getRestartRowid()
ROWID
of the data source row at which a FILL
operation will
start.RESTART-ROWID
attribute.rowid getRestartRowid(NumberType buffNum)
ROWID
of the data source row at which a FILL
operation will
start.buffNum
- The index of the buffer.RESTART-ROWID
attribute.rowid getRestartRowid(long buffNum)
ROWID
of the data source row at which a FILL
operation will
start.buffNum
- The index of the buffer.RESTART-ROWID
attribute.rowid getRestartRowid(Text buffName)
ROWID
of the data source row at which a FILL
operation will
start.buffName
- The name of the buffer.RESTART-ROWID
attribute.rowid getRestartRowid(java.lang.String buffName)
ROWID
of the data source row at which a FILL
operation will
start.buffName
- The name of the buffer.RESTART-ROWID
attribute.void setRestartRowid(rowid row)
ROWID
of the data source row at which a FILL
operation will
start. Set this attribute before each FILL
operation in a series of FILL
operations to retrieve data source rows in batches. Typically, this attribute is set by
assigning the value of the NEXT-ROWID
attribute, after each FILL
operation.row
- The new value for RESTART-ROWID
attribute as described above.void setRestartRowid(NumberType buffNum, rowid row)
ROWID
of the data source row at which a FILL
operation will
start. Set this attribute before each FILL
operation in a series of FILL
operations to retrieve data source rows in batches. Typically, this attribute is set by
assigning the value of the NEXT-ROWID
attribute, after each FILL
operation.buffNum
- The index of the buffer.row
- The new value for RESTART-ROWID
attribute as described above.void setRestartRowid(long buffNum, rowid row)
ROWID
of the data source row at which a FILL
operation will
start. Set this attribute before each FILL
operation in a series of FILL
operations to retrieve data source rows in batches. Typically, this attribute is set by
assigning the value of the NEXT-ROWID
attribute, after each FILL
operation.buffNum
- The index of the buffer.row
- The new value for RESTART-ROWID
attribute as described above.void setRestartRowid(Text buffName, rowid row)
ROWID
of the data source row at which a FILL
operation will
start. Set this attribute before each FILL
operation in a series of FILL
operations to retrieve data source rows in batches. Typically, this attribute is set by
assigning the value of the NEXT-ROWID
attribute, after each FILL
operation.buffName
- The name of the buffer.row
- The new value for RESTART-ROWID
attribute as described above.void setRestartRowid(java.lang.String buffName, rowid row)
ROWID
of the data source row at which a FILL
operation will
start. Set this attribute before each FILL
operation in a series of FILL
operations to retrieve data source rows in batches. Typically, this attribute is set by
assigning the value of the NEXT-ROWID
attribute, after each FILL
operation.buffName
- The name of the buffer.row
- The new value for RESTART-ROWID
attribute as described above.character getSaveWhereString()
WHERE
clause used to find the database buffer identified by the
buffName
in a data-source object.WHERE
clause used to find the specified buffer.character getSaveWhereString(NumberType buffNum)
WHERE
clause used to find the database buffer identified by the
buffName
in a data-source object.buffNum
- The buffer index.WHERE
clause used to find the specified buffer.character getSaveWhereString(long buffNum)
WHERE
clause used to find the database buffer identified by the
buffName
in a data-source object.buffNum
- The buffer index.WHERE
clause used to find the specified buffer.character getSaveWhereString(Text buffName)
WHERE
clause used to find the database buffer identified by the
buffName
in a data-source object.buffName
- The buffer name.WHERE
clause used to find the specified buffer.character getSaveWhereString(java.lang.String buffName)
WHERE
clause used to find the database buffer identified by the
buffName
in a data-source object.buffName
- The buffer name.WHERE
clause used to find the specified buffer.void setSaveWhereString(Text val)
SAVE-WHERE-STRING
attribute.val
- The new value for SAVE-WHERE-STRING
attribute.void setSaveWhereString(NumberType buffNum, Text val)
SAVE-WHERE-STRING
attribute.buffNum
- The buffer index.val
- The new value for SAVE-WHERE-STRING
attribute.void setSaveWhereString(long buffNum, Text val)
SAVE-WHERE-STRING
attribute.buffNum
- The buffer index.val
- The new value for SAVE-WHERE-STRING
attribute.void setSaveWhereString(Text buffName, Text val)
SAVE-WHERE-STRING
attribute.buffName
- The buffer name.val
- The new value for SAVE-WHERE-STRING
attribute.void setSaveWhereString(java.lang.String buffName, Text val)
SAVE-WHERE-STRING
attribute.buffName
- The buffer name.val
- The new value for SAVE-WHERE-STRING
attribute.void setSaveWhereString(java.lang.String val)
SAVE-WHERE-STRING
attribute.val
- The new value for SAVE-WHERE-STRING
attribute.void setSaveWhereString(NumberType buffNum, java.lang.String val)
SAVE-WHERE-STRING
attribute.buffNum
- The buffer index.val
- The new value for SAVE-WHERE-STRING
attribute.void setSaveWhereString(long buffNum, java.lang.String val)
SAVE-WHERE-STRING
attribute.buffNum
- The buffer index.val
- The new value for SAVE-WHERE-STRING
attribute.void setSaveWhereString(Text buffName, java.lang.String val)
SAVE-WHERE-STRING
attribute.buffName
- The buffer name.val
- The new value for SAVE-WHERE-STRING
attribute.void setSaveWhereString(java.lang.String buffName, java.lang.String val)
SAVE-WHERE-STRING
attribute.buffName
- The buffer name.val
- The new value for SAVE-WHERE-STRING
attribute.logical addSourceBuffer(handle buf, Text keyFields)
buf
- The buffer handle to be added.keyFields
- A list of one or more comma-separated database table fields that constitute a
unique keytrue
on success.logical addSourceBuffer(handle buf, java.lang.String keyFields)
buf
- The buffer handle to be added.keyFields
- A list of one or more comma-separated database table fields that constitute a
unique keytrue
on success.handle getSourceBuffer()
handle getSourceBuffer(long bufIndex)
bufIndex
- The index of the requested buffer.handle getSourceBuffer(NumberType bufIndex)
bufIndex
- The index of the requested buffer.handle getDatasetBuffer()
DataSource
.character getPrivateData()
PRIVATE-DATA
attribute of this handle.void setPrivateData(character data)
PRIVATE-DATA
attribute of this handle.data
- The new private-data value.void setPrivateData(java.lang.String data)
PRIVATE-DATA
attribute of this handle.data
- The new private-data value.logical isIgnoreCurrentModified()
DataSet
temp-table buffer to the associated data source using
the Buffer.saveRowChanges()
method.
This attribute is supported only for backward compatibility. Use the
getPreferDataset()
method instead.
IGNORE-CURRENT-MODIFIED
attribute.void setIgnoreCurrentModified(boolean on)
DataSet
temp-table buffer to the associated data source using
the Buffer.saveRowChanges()
method.
This attribute is supported only for backward compatibility. Use the
setPreferDataset(com.goldencode.p2j.util.logical)
method instead.
on
- The new value of IGNORE-CURRENT-MODIFIED
attribute.void setIgnoreCurrentModified(logical on)
DataSet
temp-table buffer to the associated data source using
the Buffer.saveRowChanges()
method.
This attribute is supported only for backward compatibility. Use the
setPreferDataset(com.goldencode.p2j.util.logical)
method instead.
on
- The new value of IGNORE-CURRENT-MODIFIED
attribute.