public interface Buffer extends WrappedResource, Errorable, BufferHandle, DatabaseInfo, ADMData, UniqueID, NamespaceURI, Dereferenceable, DynamicResource, Nameable, IterableResource, IndexInformation, XmlData, InstantiatingProcedure
Each DMO interface should contain a public, inner interface which extends both this class and the enclosing DMO interface. This enables DMO proxies used by business logic to invoke DMO-specific methods, as well as methods which provide standard buffer services, without requiring a cast.
Modifier and Type | Method and Description |
---|---|
boolean |
_ambiguous()
Indicate whether the last record retrieval attempt failed because the
query criteria was ambiguous.
|
boolean |
_available()
Indicate whether a backing data record currently is available.
|
boolean |
_currentChanged()
Checks if the record in the buffer has changed in database since the
last
FIND CURRENT or GET CURRENT . |
boolean |
_locked()
Indicate whether the last record retrieval attempt was denied because
the target record was locked.
|
boolean |
_newlyCreated()
Indicate whether the buffer associated currently contains a record, and
whether that record is transient.
|
logical |
ambiguous()
Indicate whether the last record retrieval attempt failed because the
query criteria was ambiguous.
|
logical |
available()
Indicate whether a backing data record currently is available.
|
void |
average(java.lang.String column,
NumberType num)
Aggregate method which averages the values of a single column across rows in the table
backing this buffer.
|
void |
average(java.lang.String column,
NumberType num,
java.lang.String where)
Aggregate method which averages the values of a single column across rows in the table
backing this buffer.
|
void |
average(java.lang.String column,
NumberType num,
java.lang.String where,
java.lang.Object... args)
Aggregate method which averages the values of a single column across rows in the table
backing this buffer.
|
logical |
bufferCompare(Buffer buffer)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCompare(Buffer buffer,
character mode)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCompare(Buffer buffer,
character mode,
character except)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCompare(Buffer buffer,
character mode,
character except,
character pairs)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCompare(Buffer buffer,
character mode,
character except,
character pairs,
logical noLobs)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCompare(handle bufHandle)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCompare(handle bufHandle,
character mode)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCompare(handle bufHandle,
character mode,
character except)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCompare(handle bufHandle,
character mode,
character except,
character pairs)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCompare(handle bufHandle,
character mode,
character except,
character pairs,
logical noLobs)
Conversion of BUFFER-COMPARE() method (KW_BUF_COMP).
|
logical |
bufferCopy(Buffer buffer)
Conversion of BUFFER-COPY() method (KW_BUF_COPY).
|
logical |
bufferCopy(Buffer buffer,
character except)
Conversion of BUFFER-COPY() method (KW_BUF_COPY).
|
logical |
bufferCopy(Buffer buffer,
character except,
character pairs)
Conversion of BUFFER-COPY() method (KW_BUF_COPY).
|
logical |
bufferCopy(Buffer buffer,
character except,
character pairs,
logical noLobs)
Conversion of BUFFER-COPY() method (KW_BUF_COPY).
|
logical |
bufferCopy(handle bufHandle)
Conversion of BUFFER-COPY() method (KW_BUF_COPY).
|
logical |
bufferCopy(handle bufHandle,
character except)
Conversion of BUFFER-COPY() method (KW_BUF_COPY).
|
logical |
bufferCopy(handle bufHandle,
character except,
character pairs)
Conversion of BUFFER-COPY() method (KW_BUF_COPY).
|
logical |
bufferCopy(handle bufHandle,
character except,
character pairs,
logical noLobs)
Conversion of BUFFER-COPY() method (KW_BUF_COPY).
|
logical |
bufferCreate()
Conversion of BUFFER-CREATE() method (KW_BUF_CREA).
|
handle |
bufferField(character fieldName)
Conversion of BUFFER-FIELD() method (KW_BUF_FLD).
|
handle |
bufferField(int fieldNumber)
Conversion of BUFFER-FIELD() method (KW_BUF_FLD).
|
handle |
bufferField(NumberType fieldNumber)
Conversion of BUFFER-FIELD() method (KW_BUF_FLD).
|
handle |
bufferField(java.lang.String fieldName)
Conversion of BUFFER-FIELD() method (KW_BUF_FLD).
|
logical |
bufferRelease()
Conversion of BUFFER-RELEASE() method (KW_BUF_REL).
|
void |
count(java.lang.String column,
NumberType num)
Aggregate method which counts the rows in the table backing this buffer.
|
void |
count(java.lang.String column,
NumberType num,
java.lang.String where)
Aggregate method which counts the rows in the table backing this buffer.
|
void |
count(java.lang.String column,
NumberType num,
java.lang.String where,
java.lang.Object... args)
Aggregate method which counts the rows in the table backing this buffer.
|
void |
create()
Create a new record in the buffer.
|
logical |
currentChanged()
Checks if the record in the buffer has changed in database since the
last
FIND CURRENT or GET CURRENT . |
void |
delete(DataModelObject[] suppDMOs,
java.lang.String where,
java.lang.Object... args)
Delete all records associated with this buffer, which match the criteria
specified by the given where clause.
|
void |
delete(java.lang.String where,
java.lang.Object... args)
Delete all records associated with this buffer, which match the criteria
specified by the given where clause.
|
logical |
deleteAll()
Bulk delete all records associated with the buffer.
|
logical |
deleteRecord()
Delete the record currently in the buffer, if any.
|
logical |
deleteRecord(java.util.function.Supplier<logical> valexp,
java.lang.String valmsg)
Delete the record currently in the buffer, IF and ONLY IF the given validation expression
evaluates
true . |
logical |
deleteRecord(java.util.function.Supplier<logical> valexp,
java.util.function.Supplier<character> valmsg)
Delete the record currently in the buffer, IF and ONLY IF the given validation expression
evaluates
true . |
void |
disableDumpTriggers()
Disable the triggers associated with the FIND event for the buffer's table.
|
void |
disableLoadTriggers(boolean allowReplication)
Disable the triggers associated with the CREATE, WRITE, DELETE and ASSIGN events for the
buffer's table.
|
logical |
findByRowID(rowid id)
Conversion of FIND-BY-ROWID() method (KW_FIND_BR).
|
logical |
findByRowID(rowid id,
LockType lockType)
Conversion of FIND-BY-ROWID() method (KW_FIND_BR).
|
logical |
findByRowID(rowid id,
long lock)
Conversion of FIND-BY-ROWID() method (KW_FIND_BR).
|
logical |
findByRowID(rowid id,
long lock,
long nowait)
Conversion of FIND-BY-ROWID() method (KW_FIND_BR).
|
logical |
findByRowID(rowid id,
long lock,
NumberType nowait)
Conversion of FIND-BY-ROWID() method (KW_FIND_BR).
|
logical |
findByRowID(rowid id,
NumberType lock)
Conversion of FIND-BY-ROWID() method (KW_FIND_BR).
|
logical |
findByRowID(rowid id,
NumberType lock,
long nowait)
Conversion of FIND-BY-ROWID() method (KW_FIND_BR).
|
logical |
findByRowID(rowid id,
NumberType lock,
NumberType nowait)
Conversion of FIND-BY-ROWID() method (KW_FIND_BR).
|
logical |
findFirst()
Conversion of FIND-FIRST() method (KW_FIND_1ST).
|
logical |
findFirst(character whereClause)
Conversion of FIND-FIRST() method (KW_FIND_1ST).
|
logical |
findFirst(character whereClause,
LockType lockType)
Conversion of FIND-FIRST() method (KW_FIND_1ST).
|
logical |
findFirst(character whereClause,
long lock)
Conversion of FIND-FIRST() method (KW_FIND_1ST).
|
logical |
findFirst(character whereClause,
long lock,
long nowait)
Conversion of FIND-FIRST() method (KW_FIND_1ST).
|
logical |
findFirst(character whereClause,
long lock,
NumberType nowait)
Conversion of FIND-FIRST() method (KW_FIND_1ST).
|
logical |
findFirst(character whereClause,
NumberType lock)
Conversion of FIND-FIRST() method (KW_FIND_1ST).
|
logical |
findFirst(character whereClause,
NumberType lock,
long nowait)
Conversion of FIND-FIRST() method (KW_FIND_1ST).
|
logical |
findFirst(character whereClause,
NumberType lock,
NumberType nowait)
Conversion of FIND-FIRST() method (KW_FIND_1ST).
|
logical |
findLast()
Conversion of FIND-LAST() method (KW_FIND_LST).
|
logical |
findLast(character whereClause)
Conversion of FIND-LAST() method (KW_FIND_LST).
|
logical |
findLast(character whereClause,
LockType lockType)
Conversion of FIND-LAST() method (KW_FIND_LST).
|
logical |
findLast(character whereClause,
long lock)
Conversion of FIND-LAST() method (KW_FIND_LST).
|
logical |
findLast(character whereClause,
long lock,
long nowait)
Conversion of FIND-LAST() method (KW_FIND_LST).
|
logical |
findLast(character whereClause,
long lock,
NumberType nowait)
Conversion of FIND-LAST() method (KW_FIND_LST).
|
logical |
findLast(character whereClause,
NumberType lock)
Conversion of FIND-LAST() method (KW_FIND_LST).
|
logical |
findLast(character whereClause,
NumberType lock,
long nowait)
Conversion of FIND-LAST() method (KW_FIND_LST).
|
logical |
findLast(character whereClause,
NumberType lock,
NumberType nowait)
Conversion of FIND-LAST() method (KW_FIND_LST).
|
logical |
findUnique()
Conversion of FIND-UNIQUE() method (KW_FIND_UNI).
|
logical |
findUnique(character whereClause)
Conversion of FIND-UNIQUE() method (KW_FIND_UNI).
|
logical |
findUnique(character whereClause,
LockType lockType)
Conversion of FIND-UNIQUE() method (KW_FIND_UNI).
|
logical |
findUnique(character whereClause,
long lock)
Conversion of FIND-UNIQUE() method (KW_FIND_UNI).
|
logical |
findUnique(character whereClause,
long lock,
long nowait)
Conversion of FIND-UNIQUE() method (KW_FIND_UNI).
|
logical |
findUnique(character whereClause,
long lock,
NumberType nowait)
Conversion of FIND-UNIQUE() method (KW_FIND_UNI).
|
logical |
findUnique(character whereClause,
NumberType lock)
Conversion of FIND-UNIQUE() method (KW_FIND_UNI).
|
logical |
findUnique(character whereClause,
NumberType lock,
long nowait)
Conversion of FIND-UNIQUE() method (KW_FIND_UNI).
|
logical |
findUnique(character whereClause,
NumberType lock,
NumberType nowait)
Conversion of FIND-UNIQUE() method (KW_FIND_UNI).
|
character |
indexInformation()
Conversion of INDEX-INFORMATION method.
|
character |
indexInformation(int indexNum)
Conversion of INDEX-INFORMATION method.
|
character |
indexInformation(NumberType indexNum)
Conversion of INDEX-INFORMATION method.
|
logical |
locked()
Indicate whether the last record retrieval attempt was denied because
the target record was locked.
|
void |
maximum(java.lang.String column,
NumberType num)
Aggregate method which finds the maximum value of a single column across rows in the table
backing this buffer.
|
void |
maximum(java.lang.String column,
NumberType num,
java.lang.String where)
Aggregate method which finds the maximum value of a single column across rows in the table
backing this buffer.
|
void |
maximum(java.lang.String column,
NumberType num,
java.lang.String where,
java.lang.Object... args)
Aggregate method which finds the maximum value of a single column across rows in the table
backing this buffer.
|
void |
minimum(java.lang.String column,
NumberType num)
Aggregate method which finds the minimum value of a single column across rows in the table
backing this buffer.
|
void |
minimum(java.lang.String column,
NumberType num,
java.lang.String where)
Aggregate method which finds the minimum value of a single column across rows in the table
backing this buffer.
|
void |
minimum(java.lang.String column,
NumberType num,
java.lang.String where,
java.lang.Object... args)
Aggregate method which finds the minimum value of a single column across rows in the table
backing this buffer.
|
logical |
newlyCreated()
Indicate whether the buffer associated currently contains a record, and
whether that record is transient.
|
integer |
numFields()
Conversion of NUM-FIELDS attribute (KW_NUM_FLD).
|
void |
rawCopyFrom(FieldReference field)
Perform a RAW-TRANSFER operation from the given raw field into this buffer.
|
void |
rawCopyFrom(raw field)
Perform a RAW-TRANSFER operation from the given raw field into this buffer.
|
void |
rawCopyTo(Buffer buffer)
Perform a RAW-TRANSFER operation from this buffer to the given buffer.
|
void |
rawCopyTo(FieldReference field)
Perform a RAW-TRANSFER operation from this buffer to the given field, which should be of
type
raw . |
void |
rawCopyTo(raw field)
Perform a RAW-TRANSFER operation from this buffer to the given raw variable.
|
logical |
rawTransfer(boolean toMode,
handle h)
RAW-TRANSFER() method implementation that maps its processing to the same methods used
for implementation of the RAW-TRANSFER statement.
|
logical |
rawTransfer(logical toMode,
handle h)
RAW-TRANSFER() method implementation that maps its processing to the same methods used
for implementation of the RAW-TRANSFER statement.
|
recid |
recordID()
Get the record ID of the current buffer's current record, if any.
|
void |
release()
Validate and release the record currently in the buffer, if any.
|
rowid |
rowID()
Get the row ID of the current buffer's current record, if any.
|
void |
sum(java.lang.String column,
NumberType num)
Aggregate method which sums the values of a single column across rows in the table
backing this buffer.
|
void |
sum(java.lang.String column,
NumberType num,
java.lang.String where)
Aggregate method which sums the values of a single column across rows in the table
backing this buffer.
|
void |
sum(java.lang.String column,
NumberType num,
java.lang.String where,
java.lang.Object... args)
Aggregate method which sums the values of a single column across rows in the table
backing this buffer.
|
handle |
tableHandle()
Conversion of TABLE-HANDLE attribute (KW_TAB_HAND).
|
void |
validate()
Validate the record currently in the buffer, if any.
|
id, id, unknown, valid
defaultBufferHandle
getDbName, getTable
getADMData, setADMData, setADMData
getUniqueID
getNamespaceURI, setNamespaceURI, setNamespaceURI
dereference, dereference
_dynamic, dynamic
currentIteration, setCurrentIteration
readXml, readXml, readXml, writeXml, writeXml, writeXml, writeXml, writeXml, writeXml, writeXml, writeXml
instantiatingProcedure
recid recordID()
This method will return a 32-bit recid which represents the internal row ID of the given record. If the actual row ID (which is implemented as a wider integer) cannot fit due to overflow, an error condition will be raised.
dmo
, a recid
initialized as unknown value is returned.ErrorConditionException
- if the actual record ID is too wide to fit within a 32-bit
integer.rowid rowID()
dmo
, a
rowid
initialized as unknown value is returned.logical available()
true
if data is available, false
if
no record backs this buffer.boolean _available()
true
if data is available, false
if
no record backs this buffer.logical currentChanged()
FIND CURRENT
or GET CURRENT
.
P2J implementation of 4GL function CURRENT-CHANGED
.true
if the database record differs from the
value in memory buffer that was queried with the last
FIND
and false
otherwiseboolean _currentChanged()
FIND CURRENT
or GET CURRENT
.
P2J implementation of 4GL function CURRENT-CHANGED
.true
if the database record differs from the
value in memory buffer that was queried with the last
FIND
and false
otherwiselogical newlyCreated()
true
if a record exists and is new, else
false
.boolean _newlyCreated()
true
if a record exists and is new, else
false
.logical locked()
true
if the record was locked; false
if the attempt succeeded, or if this query has not yet
attempted to retrieve a record.boolean _locked()
true
if the record was locked; false
if the attempt succeeded, or if this query has not yet
attempted to retrieve a record.logical ambiguous()
true
if the query was ambiguous;
false
if the attempt succeeded, or if no attempt
has yet been made.boolean _ambiguous()
true
if the query was ambiguous;
false
if the attempt succeeded, or if no attempt
has yet been made.void rawCopyTo(raw field)
field
- A raw
field to which to copy the record in this buffer.void rawCopyTo(FieldReference field)
raw
. Serializes the record currently in the buffer into the specified
field.field
- A raw
field to which to copy the record in this buffer.void rawCopyTo(Buffer buffer)
buffer
- A buffer into which to copy the record in this buffer.void rawCopyFrom(FieldReference field)
field
- A raw
field from which to copy the record into this buffer.void rawCopyFrom(raw field)
field
- A raw
field from which to copy the record into this buffer.logical rawTransfer(boolean toMode, handle h)
toMode
- true
if the copy direction is into the handle's resource and false
if the data is being copied into the buffer.h
- A buffer or raw buffer field.true
if RAW-TRANSFER() succeeds, else false
.logical rawTransfer(logical toMode, handle h)
toMode
- true
if the copy direction is into the handle's resource and false
if the data is being copied into the buffer.h
- A buffer or raw buffer field.true
if RAW-TRANSFER() succeeds, else false
.void create()
ErrorConditionException
- if there is an error retrieving the next available primary key
from the database or locking the record.logical deleteRecord()
true
if the delete was possible.ErrorConditionException
- if no record currently is loaded in the buffer, or if there is
an error deleting the current record from the database.logical deleteRecord(java.util.function.Supplier<logical> valexp, java.lang.String valmsg)
true
.valexp
- The validation expression to evaluate.valmsg
- The error message to display when validation fails.true
if validation succeeds, false
if it fails and no
exception is raised.ErrorConditionException
- If no record currently is loaded in the buffer, or if there is an error deleting
the current record from the database or if the validation expression fails.logical deleteRecord(java.util.function.Supplier<logical> valexp, java.util.function.Supplier<character> valmsg)
true
.valexp
- The validation expression to evaluate.valmsg
- The error message to display when validation fails.true
if validation succeeds, false
if it fails and no
exception is raised.ErrorConditionException
- If no record currently is loaded in the buffer, or if there is an error deleting
the current record from the database or if the validation expression fails.void delete(java.lang.String where, java.lang.Object... args)
NOTE: the current implementation must not be invoked for a DMO which is backed by a permanent table; only temp-table bulk delete is supported at this time.
where
- An HQL where clause snippet which defines the restriction
criteria to apply to the delete. All references to properties
in a DMO must be unqualified.args
- Query substitution parameters required by the where clause.ErrorConditionException
- if there is an error deleting the records.java.lang.UnsupportedOperationException
- if invoked on a buffer associated with a permanent table.void delete(DataModelObject[] suppDMOs, java.lang.String where, java.lang.Object... args)
NOTE: the current implementation must not be invoked for a DMO which is backed by a permanent table; only temp-table bulk delete is supported at this time.
suppDMOs
- The DMOs for the external (additional) buffers that are accessed in inner
subselect, or null
in case of a simple where
predicate.where
- An HQL where clause snippet which defines the restriction
criteria to apply to the delete. All references to properties
in a DMO must be unqualified.args
- Query substitution parameters required by the where clause.ErrorConditionException
- if there is an error deleting the records.java.lang.UnsupportedOperationException
- if invoked on a buffer associated with a permanent table.logical deleteAll()
true
if the delete was possible.ErrorConditionException
- if an error occurs performing the bulk delete operation.void average(java.lang.String column, NumberType num)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.ErrorConditionException
- if an error occurs performing the aggregate operation.void average(java.lang.String column, NumberType num, java.lang.String where)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.ErrorConditionException
- if an error occurs performing the aggregate operation.void average(java.lang.String column, NumberType num, java.lang.String where, java.lang.Object... args)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.args
- Query substitution arguments.ErrorConditionException
- if an error occurs performing the aggregate operation.void count(java.lang.String column, NumberType num)
column
- An expression indicating the name of the column to aggregate. May be the wildcard
character ("*").num
- Variable into which to store the aggregate result.ErrorConditionException
- if an error occurs performing the aggregate operation.void count(java.lang.String column, NumberType num, java.lang.String where)
column
- An expression indicating the name of the column to aggregate. May be the wildcard
character ("*").num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.ErrorConditionException
- if an error occurs performing the aggregate operation.void count(java.lang.String column, NumberType num, java.lang.String where, java.lang.Object... args)
column
- An expression indicating the name of the column to aggregate. May be the wildcard
character ("*").num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.args
- Query substitution arguments.ErrorConditionException
- if an error occurs performing the aggregate operation.void minimum(java.lang.String column, NumberType num)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.ErrorConditionException
- if an error occurs performing the aggregate operation.void minimum(java.lang.String column, NumberType num, java.lang.String where)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.ErrorConditionException
- if an error occurs performing the aggregate operation.void minimum(java.lang.String column, NumberType num, java.lang.String where, java.lang.Object... args)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.args
- Query substitution arguments.ErrorConditionException
- if an error occurs performing the aggregate operation.void maximum(java.lang.String column, NumberType num)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.ErrorConditionException
- if an error occurs performing the aggregate operation.void maximum(java.lang.String column, NumberType num, java.lang.String where)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.ErrorConditionException
- if an error occurs performing the aggregate operation.void maximum(java.lang.String column, NumberType num, java.lang.String where, java.lang.Object... args)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.args
- Query substitution arguments.ErrorConditionException
- if an error occurs performing the aggregate operation.void sum(java.lang.String column, NumberType num)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.ErrorConditionException
- if an error occurs performing the aggregate operation.void sum(java.lang.String column, NumberType num, java.lang.String where)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.ErrorConditionException
- if an error occurs performing the aggregate operation.void sum(java.lang.String column, NumberType num, java.lang.String where, java.lang.Object... args)
column
- An expression indicating the name of the column to aggregate.num
- Variable into which to store the aggregate result.where
- HQL where clause used to filter the records.args
- Query substitution arguments.ErrorConditionException
- if an error occurs performing the aggregate operation.void release()
ErrorConditionException
- if the buffer fails validation.void validate()
ErrorConditionException
- if the buffer fails validation.handle bufferField(int fieldNumber)
fieldNumber
- An INTEGER expression representing the sequence number of the field in the buffer.handle bufferField(NumberType fieldNumber)
fieldNumber
- An INTEGER expression representing the sequence number of the field in the buffer.handle bufferField(java.lang.String fieldName)
fieldName
- A string expression representing the name of the field in the buffer.handle bufferField(character fieldName)
fieldName
- A CHARACTER string expression representing the name of the field in the buffer.logical bufferCopy(Buffer buffer)
buffer
- The source buffer to copy from.true
if BUFFER-COPY() succeeds, else false
.logical bufferCopy(Buffer buffer, character except)
buffer
- The source buffer to copy from.except
- A comma-separated list of fields that will be ignored in the copy process.true
if BUFFER-COPY() succeeds, else false
.logical bufferCopy(Buffer buffer, character except, character pairs)
buffer
- The source buffer to copy from.except
- A comma-separated list of fields that will be ignored in the copy process.pairs
- A comma-separated list of field-name pairs to be copied. Each pair must contain
one field name from the source and one field name from the target.true
if BUFFER-COPY() succeeds, else false
.logical bufferCopy(Buffer buffer, character except, character pairs, logical noLobs)
buffer
- The source buffer to copy from.except
- A comma-separated list of fields that will be ignored in the copy process.pairs
- A comma-separated list of field-name pairs to be copied. Each pair must contain
one field name from the source and one field name from the target.noLobs
- If TRUE
, BLOB and CLOB fields are ignored during the copy.true
if BUFFER-COPY() succeeds, else false
.logical bufferCopy(handle bufHandle)
bufHandle
- The handle of the source buffer to copy from.true
if BUFFER-COPY() succeeds, else false
.logical bufferCopy(handle bufHandle, character except)
bufHandle
- The handle of the source buffer to copy from.except
- A comma-separated list of fields that will be ignored in the copy process.true
if BUFFER-COPY() succeeds, else false
.logical bufferCopy(handle bufHandle, character except, character pairs)
bufHandle
- The handle of the source buffer to copy from.except
- A comma-separated list of fields that will be ignored in the copy process.pairs
- A comma-separated list of field-name pairs to be copied. Each pair must contain
one field name from the source and one field name from the target.true
if BUFFER-COPY() succeeds, else false
.logical bufferCopy(handle bufHandle, character except, character pairs, logical noLobs)
bufHandle
- The handle of the source buffer to copy from.except
- A comma-separated list of fields that will be ignored in the copy process.pairs
- A comma-separated list of field-name pairs to be copied. Each pair must contain
one field name from the source and one field name from the target.noLobs
- If TRUE
, BLOB and CLOB fields are ignored during the copy.true
if BUFFER-COPY() succeeds, else false
.logical bufferCompare(Buffer buffer)
buffer
- Buffer with which to compare.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCompare(Buffer buffer, character mode)
buffer
- Buffer with which to compare.mode
- The text "binary" or "case-sensitive", to provide that type of comparison.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCompare(Buffer buffer, character mode, character except)
buffer
- Buffer with which to compare.mode
- The text "binary" or "case-sensitive", to provide that type of comparison.except
- A comma-separated list of fields that will be ignored in the compare process.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCompare(Buffer buffer, character mode, character except, character pairs)
buffer
- Buffer with which to compare.mode
- The text "binary" or "case-sensitive", to provide that type of comparison.except
- A comma-separated list of fields that will be ignored in the compare process.pairs
- A comma-separated list of field-name pairs to be compared. Each pair must contain
one field name from the source and one field name from the target.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCompare(Buffer buffer, character mode, character except, character pairs, logical noLobs)
buffer
- Buffer with which to compare.mode
- The text "binary" or "case-sensitive", to provide that type of comparison.except
- A comma-separated list of fields that will be ignored in the compare process.pairs
- A comma-separated list of field-name pairs to be compared. Each pair must contain
one field name from the source and one field name from the target.noLobs
- If TRUE
, BLOB and CLOB fields are ignored during the copy.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCompare(handle bufHandle)
bufHandle
- Handle of buffer with which to compare.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCompare(handle bufHandle, character mode)
bufHandle
- Handle of buffer with which to compare.mode
- The text "binary" or "case-sensitive", to provide that type of comparison.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCompare(handle bufHandle, character mode, character except)
bufHandle
- Handle of buffer with which to compare.mode
- The text "binary" or "case-sensitive", to provide that type of comparison.except
- A comma-separated list of fields that will be ignored in the compare process.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCompare(handle bufHandle, character mode, character except, character pairs)
bufHandle
- Handle of buffer with which to compare.mode
- The text "binary" or "case-sensitive", to provide that type of comparison.except
- A comma-separated list of fields that will be ignored in the compare process.pairs
- A comma-separated list of field-name pairs to be compared. Each pair must contain
one field name from the source and one field name from the target.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCompare(handle bufHandle, character mode, character except, character pairs, logical noLobs)
bufHandle
- Handle of buffer with which to compare.mode
- The text "binary" or "case-sensitive", to provide that type of comparison.except
- A comma-separated list of fields that will be ignored in the compare process.pairs
- A comma-separated list of field-name pairs to be compared. Each pair must contain
one field name from the source and one field name from the target.noLobs
- If TRUE
, BLOB and CLOB fields are ignored during the copy.true
if BUFFER-COMPARE() succeeds,
else false
.logical bufferCreate()
true
if successfullogical findFirst()
true
if FIND-FIRST() succeeds,
else false
.logical findFirst(character whereClause)
whereClause
- where clause, predicate-expression.true
if FIND-FIRST() succeeds,
else false
.logical findFirst(character whereClause, LockType lockType)
whereClause
- where clause, predicate-expression.lockType
- Lock typetrue
if FIND-FIRST() succeeds,
else false
.logical findFirst(character whereClause, long lock)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKtrue
if FIND-FIRST() succeeds,
else false
.logical findFirst(character whereClause, NumberType lock)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKtrue
if FIND-FIRST() succeeds,
else false
.logical findFirst(character whereClause, long lock, long nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-FIRST() succeeds,
else false
.logical findFirst(character whereClause, NumberType lock, long nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-FIRST() succeeds,
else false
.logical findFirst(character whereClause, long lock, NumberType nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-FIRST() succeeds,
else false
.logical findFirst(character whereClause, NumberType lock, NumberType nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-FIRST() succeeds,
else false
.logical findLast()
true
if FIND-LAST() succeeds,
else false
.logical findLast(character whereClause)
whereClause
- where clause, predicate-expression.true
if FIND-LAST() succeeds,
else false
.logical findLast(character whereClause, LockType lockType)
whereClause
- where clause, predicate-expression.lockType
- Lock typetrue
if FIND-LAST() succeeds,
else false
.logical findLast(character whereClause, long lock)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKtrue
if FIND-LAST() succeeds,
else false
.logical findLast(character whereClause, NumberType lock)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKtrue
if FIND-LAST() succeeds,
else false
.logical findLast(character whereClause, long lock, long nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-LAST() succeeds,
else false
.logical findLast(character whereClause, NumberType lock, long nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-LAST() succeeds,
else false
.logical findLast(character whereClause, long lock, NumberType nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-LAST() succeeds,
else false
.logical findLast(character whereClause, NumberType lock, NumberType nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-LAST() succeeds,
else false
.logical findUnique()
true
if FIND-UNIQUE() succeeds,
else false
.logical findUnique(character whereClause)
whereClause
- where clause, predicate-expression.true
if FIND-UNIQUE() succeeds,
else false
.logical findUnique(character whereClause, LockType lockType)
whereClause
- where clause, predicate-expression.lockType
- Lock typetrue
if FIND-UNIQUE() succeeds,
else false
.logical findUnique(character whereClause, long lock)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKtrue
if FIND-UNIQUE() succeeds,
else false
.logical findUnique(character whereClause, NumberType lock)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKtrue
if FIND-UNIQUE() succeeds,
else false
.logical findUnique(character whereClause, long lock, long nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-UNIQUE() succeeds,
else false
.logical findUnique(character whereClause, NumberType lock, long nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-UNIQUE() succeeds,
else false
.logical findUnique(character whereClause, long lock, NumberType nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-UNIQUE() succeeds,
else false
.logical findUnique(character whereClause, NumberType lock, NumberType nowait)
whereClause
- where clause, predicate-expression.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if FIND-UNIQUE() succeeds,
else false
.logical bufferRelease()
true
if BUFFER-RELEASE() succeeds,
else false
.logical findByRowID(rowid id)
id
- An expression of type ROWID that represents the rowid of the
desired record.true
if it finds the record, else
false
.logical findByRowID(rowid id, LockType lockType)
id
- An expression of type ROWID that represents the rowid of the
desired record.lockType
- Lock typetrue
if it finds the record, else
false
.logical findByRowID(rowid id, long lock)
id
- An expression of type ROWID that represents the rowid of the
desired record.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKtrue
if it finds the record, else
false
.logical findByRowID(rowid id, NumberType lock)
id
- An expression of type ROWID that represents the rowid of the
desired record.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKtrue
if it finds the record, else
false
.logical findByRowID(rowid id, long lock, long nowait)
id
- An expression of type ROWID that represents the rowid of the
desired record.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if it finds the record, else
false
.logical findByRowID(rowid id, NumberType lock, long nowait)
id
- An expression of type ROWID that represents the rowid of the
desired record.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if it finds the record, else
false
.logical findByRowID(rowid id, long lock, NumberType nowait)
id
- An expression of type ROWID that represents the rowid of the
desired record.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if it finds the record, else
false
.logical findByRowID(rowid id, NumberType lock, NumberType nowait)
id
- An expression of type ROWID that represents the rowid of the
desired record.lock
- SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCKnowait
- NO-WAITtrue
if it finds the record, else
false
.integer numFields()
void disableDumpTriggers()
void disableLoadTriggers(boolean allowReplication)
allowReplication
- If true
then only CREATE, DELETE, ASSIGN and WRITE triggers are
disabled, and not REPLICATION-CREATE, REPLICATION-DELETE and REPLICATION-WRITE
triggers.handle tableHandle()
character indexInformation()
indexInformation
in interface IndexInformation
character indexInformation(int indexNum)
indexInformation
in interface IndexInformation
indexNum
- 1-based number of the index in the definition order.character indexInformation(NumberType indexNum)
indexInformation
in interface IndexInformation
indexNum
- 1-based number of the index in the definition order.