P2JQuery (P2J - Progress 4GL to Java Conversion and Runtime)

All Superinterfaces:

BufferCollection, IndexInformation, Openable

All Known Subinterfaces:

HandleCommon, Joinable, Scrollable

All Known Implementing Classes:

AbstractQuery, AdaptiveFind.AdaptiveFindQuery, AdaptiveQuery, CompoundQuery, DynamicQuery, FindQuery, PreselectQuery, PresortCompoundQuery, PresortQuery, QueryWrapper, QueryWrapper.DefaultDelegate, RandomAccessQuery
```
public interface P2JQuery
extends BufferCollection, IndexInformation, Openable
```
The minimal API all query implementations must provide. Defines methods to retrieve and navigate results and to access query metadata.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`P2JQuery.Parameter` Functional interface used with lambda expressions to defer evaluation of certain query substitution parameter expressions.
`static interface`	`P2JQuery.ParamResolver` Functional interface used with lambda expressions to late defer evaluation of certain query substitution parameter expressions.
`static interface`	`P2JQuery.QueryEventListener` Interface for receiving query events.
`static interface`	`P2JQuery.QueryOpenedListener` Interface for receiving query open events after the query has been opened.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`_getNext()` Conversion of GET-NEXT method (KW_GET_NEXT), which returns a Java boolean, for internal usage.
`boolean`	`_isOffEnd()` Indicate whether the cursor has run off one or the other end of the associated query's list of available results.
`void`	`addAccumulator(Accumulator accum)` Add an accumulator to this query.
`void`	`addAccumulator(Accumulator accum, boolean deferred)` Add an accumulator to this query.
`boolean`	`addDynamicFilter(FieldReference fr, BaseDataType val, java.lang.String format)` Adds a new constraint term to the where predicate of this query, effectively filtering out any rows whose referenced field does not match the requested value.
`P2JQuery`	`addExternalBuffers(DataModelObject... dmos)` Add one or more buffers to the list of those which this query references externally.
`default void`	`addQueryEventListener(P2JQuery.QueryEventListener qel)` Adds a listener to be notified when this query is opened or closed.
`void`	`addRepositionListener(RepositionListener listener)` Register a listener to receive notifications reposition events for this query.
`boolean`	`backward(int rows)` Move the current cursor position backward by the specified number of rows.
`boolean`	`backward(NumberType rows)` Move the current cursor position backward by the specified number of rows.
`void`	`changeForwardOnly(boolean forwardOnly)` Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY).
`void`	`changeForwardOnly(logical forwardOnly)` Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY).
`void`	`cleanup()` Clean up resources associated with this query when its scope ends.
`void`	`clearDynamicFilters()` Clears any dynamically filters added at runtime.
`void`	`clearResults()` Clear the current results from the query, so the same query instance can be executed again, without having to `re-open` it.
`void`	`close()` Explicitly close the prepared query.
`default void`	`close(boolean inResource)` Explicitly close the prepared query.
`logical`	`createResultListEntry()` Creates an entry in the result list for the current row.
`boolean`	`current()` Reload the current composite row of results for the query.
`boolean`	`current(LockType lockType)` Reload the current composite row of results for the query, overriding the lock type to apply to each record.
`integer`	`currentRow()` Progress-compatible function that returns the 1-based index of the current row in the result set.
`integer`	`currentRowImpl()` Get the 1-based index of the current row in the result set.
`logical`	`deleteResultListEntry()` Deletes the current row of a query's result list.
`logical`	`deleteResultListEntry(boolean allowBetweenRows)` Deletes the current row of a query's result list.
`void`	`exclude(DataModelObject dmo, java.lang.String... fields)` Specifies the fields excluded from a record retrieval.
`boolean`	`first()` Retrieve the first composite row of results for the query.
`boolean`	`first(LockType lockType)` Retrieve the first composite row of results for the query.
`boolean`	`forward(int rows)` Advance the current cursor position forward by the specified number of rows.
`boolean`	`forward(NumberType rows)` Advance the current cursor position forward by the specified number of rows.
`logical`	`forwardOnly()` Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY).
`default logical`	`getBasicLogging()` Getter for the BASIC-LOGGING attribute.
`integer`	`getCache()` Getter for the CACHE attribute.
`logical`	`getCurrent()` Conversion of GET-CURRENT() method (KW_GET_CUR).
`logical`	`getCurrent(LockType lockType)` Conversion of GET-CURRENT() method (KW_GET_CUR).
`logical`	`getCurrent(long lock)` Conversion of GET-CURRENT() method (KW_GET_CUR).
`logical`	`getCurrent(long lock, long nowait)` Conversion of GET-CURRENT() method (KW_GET_CUR).
`logical`	`getCurrent(long lock, NumberType nowait)` Conversion of GET-CURRENT() method (KW_GET_CUR).
`logical`	`getCurrent(NumberType lock)` Conversion of GET-CURRENT() method (KW_GET_CUR).
`logical`	`getCurrent(NumberType lock, long nowait)` Conversion of GET-CURRENT() method (KW_GET_CUR).
`logical`	`getCurrent(NumberType lock, NumberType nowait)` Conversion of GET-CURRENT() method (KW_GET_CUR).
`default DataRelation`	`getDataRelation()` Get the recursive DATA-RELATION the query is to FILL for.
`logical`	`getFirst()` Conversion of GET-FIRST method (KW_GET_1ST).
`logical`	`getFirst(LockType lockType)` Conversion of GET-FIRST method (KW_GET_1ST).
`logical`	`getFirst(long lock)` Conversion of GET-FIRST method (KW_GET_1ST).
`logical`	`getFirst(long lock, long nowait)` Conversion of GET-FIRST method (KW_GET_1ST).
`logical`	`getFirst(long lock, NumberType nowait)` Conversion of GET-FIRST method (KW_GET_1ST).
`logical`	`getFirst(NumberType lock)` Conversion of GET-FIRST method (KW_GET_1ST).
`logical`	`getFirst(NumberType lock, long nowait)` Conversion of GET-FIRST method (KW_GET_1ST).
`logical`	`getFirst(NumberType lock, NumberType nowait)` Conversion of GET-FIRST method (KW_GET_1ST).
`default AbstractJoin`	`getJoin()` Get the legacy natural join, if any, associated with this query.
`logical`	`getLast()` Conversion of GET-LAST method (KW_GET_LAST).
`logical`	`getLast(LockType lockType)` Conversion of GET-LAST method (KW_GET_LAST).
`logical`	`getLast(long lock)` Conversion of GET-LAST method (KW_GET_LAST).
`logical`	`getLast(long lock, long nowait)` Conversion of GET-LAST method (KW_GET_LAST).
`logical`	`getLast(long lock, NumberType nowait)` Conversion of GET-LAST method (KW_GET_LAST).
`logical`	`getLast(NumberType lock)` Conversion of GET-LAST method (KW_GET_LAST).
`logical`	`getLast(NumberType lock, long nowait)` Conversion of GET-LAST method (KW_GET_LAST).
`logical`	`getLast(NumberType lock, NumberType nowait)` Conversion of GET-LAST method (KW_GET_LAST).
`default logical`	`getNext()` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(LockType lockType)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(long lock)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(long lock, long nowait)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(long lock, NumberType nowait)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(NumberType lock)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(NumberType lock, long nowait)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(NumberType lock, NumberType nowait)` Conversion of GET-NEXT method (KW_GET_NEXT).
`integer`	`getNumResults()` Conversion of NUM-RESULTS attribute (KW_NUM_RES).
`OffEnd`	`getOffEnd()` Get the off-end status of this query, which indicates whether the query has run off either end of its results.
`java.util.ArrayList<QueryOffEndListener>`	`getOffEndListeners()` Get all the off-end listeners associated with this query.
`logical`	`getPrevious()` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(LockType lockType)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(long lock)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(long lock, long nowait)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(long lock, NumberType nowait)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(NumberType lock)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(NumberType lock, long nowait)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(NumberType lock, NumberType nowait)` Conversion of GET-PREV method (KW_GET_PREV).
`default RecordBuffer[]`	`getRecordBuffers()` Get an array of all record buffers managed by this query.
`int`	`getTableCount()` Get the number of tables joined by this query.
`logical`	`hasAny()` Indicate whether a request to find the first result of this query would succeed or fail.
`logical`	`hasAny(LockType lockType)` Indicate whether a request to find the first result of this query would succeed or fail.
`logical`	`hasAny(java.lang.Object[] values)` Indicate whether a request to find the first result of this query would succeed or fail.
`logical`	`hasAny(java.lang.Object[] values, LockType lockType)` Indicate whether a request to find the first result of this query would succeed or fail.
`logical`	`hasOne()` Indicate whether this query would produce a unique result.
`logical`	`hasOne(LockType lockType)` Indicate whether this query would produce a unique result.
`logical`	`hasOne(java.lang.Object[] values)` Indicate whether this query would produce a unique result.
`logical`	`hasOne(java.lang.Object[] values, LockType lockType)` Indicate whether this query would produce a unique result.
`default void`	`hintFullResults()` Mark the query to retrieve the entire result set (useful for FILL operations).
`void`	`include(DataModelObject dmo, java.lang.String... fields)` Specifies the fields included in a record retrieval.
`character`	`indexInformation()` Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO).
`character`	`indexInformation(int n)` Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO).
`character`	`indexInformation(NumberType n)` Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO).
`boolean`	`isBrowsed()` Is this query associated with a browse widget or not?
`default boolean`	`isDynamicPredicate()` Check if this query is originating from a dynamic predicate.
`boolean`	`isFetchOnReposition()` Is this query set to fetch the next record after a reposition?
`default boolean`	`isFillingBrowseRows()` Test whether the flag was set.
`default boolean`	`isFindByRowid()` Indicate whether this query is a simple RECID/ROWID lookup FIND query.
`default logical`	`isFirstOfGroup(int level)` Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
`default logical`	`isFirstOfGroup(integer level)` Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
`boolean`	`isIndexedReposition()` Indicate whether this query was optimized using indexed reposition.
`boolean`	`isIterating()` Indicate whether the query is defined inside the scope of FOR EACH block.
`default logical`	`isLastOfGroup(int level)` Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
`default logical`	`isLastOfGroup(integer level)` Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
`boolean`	`isNativelyPreselect()` Indicate whether this query is a preselect query by its nature.
`logical`	`isOffEnd()` Indicate whether the cursor has run off one or the other end of the associated query's list of available results.
`boolean`	`isPreselect()` Indicate whether this query preselects all of its results.
`boolean`	`isPresort()` Indicate whether the query is of presort type.
`boolean`	`isScrolling()` Indicate whether this query was defined as SCROLLING.
`logical`	`isSkipDeletedRecord()` Get value of SKIP-DELETED-RECORD attribute of the query.
`boolean`	`isStandalone()` Indicate whether this query stands alone, or is the component of another query, or is wrapped by a query wrapper.
`boolean`	`last()` Retrieve the last composite row of results for the query.
`boolean`	`last(LockType lockType)` Retrieve the last composite row of results for the query.
`boolean`	`next()` Retrieve the next composite row of results for the query.
`boolean`	`next(LockType lockType)` Retrieve the next composite row of results for the query.
`default void`	`notifyQueryCloseListeners()` Notifies the registered QUERY-CLOSE listeners that the even is about to happen.
`default void`	`notifyQueryOpenListeners(boolean evaluate)` Notifies the registered QUERY-OPEN listeners that the even is about to happen.
`void`	`notifyRepositionListeners(boolean closed, boolean error, int targetRepositionRow)` Notify all registered listeners that query is repositioned or closed.
`void`	`open()` Open the prepared query.
`logical`	`prepare(character predicate)` Compiles a predicate (query condition).
`logical`	`prepare(java.lang.String predicate)` Compiles a predicate (query condition).
`character`	`prepareString()` Conversion of PREPARE_STRING attribute (KW_PREP_STR).
`boolean`	`previous()` Retrieve the previous composite row of results for the query.
`boolean`	`previous(LockType lockType)` Retrieve the previous composite row of results for the query.
`logical`	`queryBackward(int rows)` Conversion of REPOSITION-BACKWARD() method (KW_REPOS_B).
`logical`	`queryBackward(NumberType rows)` Conversion of REPOSITION-BACKWARD() method (KW_REPOS_B).
`logical`	`queryClose()` Conversion of QUERY-CLOSE() method (KW_QRY_CLOS).
`logical`	`queryForward(int rows)` Conversion of REPOSITION-FORWARD() method (KW_REPOS_F).
`logical`	`queryForward(NumberType rows)` Conversion of REPOSITION-FORWARD() method (KW_REPOS_F).
`logical`	`queryOpen()` Opens a query object.
`logical`	`queryReposition(int n)` Conversion of REPOSITION-TO-ROW() method (KW_REPOS_2R).
`logical`	`queryReposition(NumberType n)` Conversion of REPOSITION-TO-ROW() method (KW_REPOS_2R).
`default logical`	`queryRepositionByID(character rowId)` Conversion of REPOSITION-TO-ROWID() method (KW_REPOS_2I).
`logical`	`queryRepositionByID(rowid id1, rowid... joinIDs)` Conversion of REPOSITION-TO-ROWID() method (KW_REPOS_2I).
`void`	`releaseBuffers()` Releases the buffers controlled by this query.
`void`	`removeRepositionListener(RepositionListener listener)` Unregister a listener that was receiving notifications on reposition events for this query.
`void`	`reposition(int row)` Reposition the query to the specified row in the result set.
`void`	`reposition(NumberType row)` Reposition the cursor to the specified row in the result set.
`boolean`	`repositionByID(java.lang.Long... joinIDs)` Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs.
`void`	`repositionByID(recid id)` Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified primary key ID.
`void`	`repositionByID(rowid id1, rowid... joinIDs)` Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs.
`default void`	`resetQuery()` Reset the query (this does not close the query).
`default void`	`setBasicLogging(boolean val)` Setter for the BASIC-LOGGING attribute.
`default void`	`setBasicLogging(logical val)` Setter for the BASIC-LOGGING attribute.
`void`	`setBrowsed(boolean browsed)` Indicate to this query that whether it is associated with a browse widget or not.
`void`	`setCache(integer n)` Setter for the CACHE attribute.
`void`	`setCache(long n)` Setter for the CACHE attribute.
`default void`	`setDataRelation(DataRelation relation)` Set the recursive DATA-RELATION the query is to FILL for.
`default void`	`setDynamicPredicate(boolean dynamic)` Set this query in a 'dynamic' mode, to mark the fact that it is originating from a dynamic predicate.
`void`	`setErrorIfNull(boolean errorIfNull)` Set a mode such that setting a null record into a backing buffer may or may not result in an error condition.
`void`	`setFetchOnReposition(boolean enable)` Set this query to automatically fetch the next record after a reposition, or turn this feature off.
`default void`	`setFillingBrowseRows(boolean on)` Informs the query that the next operations will be performed for filling browse rows, so it should not return deleted rows/records (if argument is `true`).
`void`	`setIndexedReposition()` Enable indexed reposition optimization.
`void`	`setIterating(boolean iterating)` Indicate whether the query is defined inside the scope of FOR EACH block.
`void`	`setLenientOffEnd(boolean lenientOffEnd)` Set the behavior of this query as a record retrieval request moves off the end of its results.
`void`	`setParameterFilter(ParameterFilter parameterFilter)` Set the filter that handles parameters passed to the query.
`void`	`setPresort(boolean presort)` Indicate whether the query is of presort type.
`void`	`setScrolling()` Enable results list scrolling/repositioning.
`void`	`setSkipDeletedRecord(logical on)` Setter for SKIP-DELETED-RECORD query attribute.
`void`	`setStandalone(boolean standalone)` Change the standalone nature of this query.
`integer`	`size()` Get the *current* size of the cached results list.
`default boolean`	`unique()` Retrieve a unique record (only valid for a single-table query).
`default boolean`	`unique(LockType lockType)` Retrieve a unique record (only valid for a single-table query), overriding the default lock type of the underlying query component.

Methods inherited from interface com.goldencode.p2j.persist.BufferCollection
addBuffer, addBuffer, addBuffer, addBuffer, bufferHandle, bufferHandle, bufferHandle, bufferHandle, bufferHandle, numBuffers, setBuffers, setBuffers, setBuffers

Methods inherited from interface com.goldencode.p2j.util.Openable
isOpen

- Method Detail
  - clearResults
```
void clearResults()
```
    Clear the current results from the query, so the same query instance can be executed again, without having to re-open it.
  - setDynamicPredicate
```
default void setDynamicPredicate(boolean dynamic)
```
    Set this query in a 'dynamic' mode, to mark the fact that it is originating from a dynamic predicate.
    
    Parameters:
    
    dynamic - Flag indicating that this is from a dynamic predicate for a query resource.
  - isDynamicPredicate
```
default boolean isDynamicPredicate()
```
    Check if this query is originating from a dynamic predicate.
    
    Returns:
    
    Always false.
  - setScrolling
```
void setScrolling()
```
    Enable results list scrolling/repositioning.
  - isScrolling
```
boolean isScrolling()
```
    Indicate whether this query was defined as SCROLLING.
    
    Returns:
    
    true if this query is scrolling.
  - setIndexedReposition
```
void setIndexedReposition()
```
    Enable indexed reposition optimization.
  - isIndexedReposition
```
boolean isIndexedReposition()
```
    Indicate whether this query was optimized using indexed reposition.
    
    Returns:
    
    true if this query is indexed reposition.
  - open
```
void open()
```
    Open the prepared query.
  - close
```
void close()
```
    Explicitly close the prepared query.
  - close
```
default void close(boolean inResource)
```
    Explicitly close the prepared query.
    
    Parameters:
    
    inResource - Flag indicating this query is used in a QUERY legacy resource.
  - resetQuery
```
default void resetQuery()
```
    Reset the query (this does not close the query).
  - getTableCount
```
int getTableCount()
```
    Get the number of tables joined by this query.
    
    Returns:
    
    Number of joined tables.
  - getRecordBuffers
```
default RecordBuffer[] getRecordBuffers()
```
    Get an array of all record buffers managed by this query.
    
    Returns:
    
    All record buffers managed by this query.
  - addExternalBuffers
```
P2JQuery addExternalBuffers(DataModelObject... dmos)
```
    Add one or more buffers to the list of those which this query references externally. These typically will be buffers referenced by converted CAN-FIND expressions embedded in the query's HQL expression, which are not the primary buffers associated with the query.
    
    Parameters:
    
    dmos - One or more external buffers.
    
    Returns:
    
    This instance, so that this method can be chained to the constructor and return this instance to the caller.
  - getJoin
```
default AbstractJoin getJoin()
```
    Get the legacy natural join, if any, associated with this query.
    
    Returns:
    
    Legacy join object, or null if none.
  - getOffEndListeners
```
java.util.ArrayList<QueryOffEndListener> getOffEndListeners()
```
    Get all the off-end listeners associated with this query.
    
    Returns:
    
    the off-end listeners associated with this query.
  - setErrorIfNull
```
void setErrorIfNull(boolean errorIfNull)
```
    Set a mode such that setting a null record into a backing buffer may or may not result in an error condition. This applies only to requests to retrieve FIRST, LAST, and UNIQUE records.
    
    Parameters:
    
    errorIfNull - If true, setting a null value as the current record in an underlying buffer will raise an error condition (if not in silent error mode); if false, this action will raise an end condition instead.
  - setLenientOffEnd
```
void setLenientOffEnd(boolean lenientOffEnd)
```
    Set the behavior of this query as a record retrieval request moves off the end of its results. If set to lenient mode, invocations of next and previous which do not find a record do not raise a QueryOffEndException. By default, this would normally raise the exception.
    
    Parameters:
    
    lenientOffEnd - true to suppress QueryOffEndException for next and previous requests; false to permit these exceptions.
  - setIterating
```
void setIterating(boolean iterating)
```
    Indicate whether the query is defined inside the scope of FOR EACH block.
    
    Parameters:
    
    iterating - true indicating that a query is inside FOR EACH block; false is defined outside of a FOR EACH.
  - isIterating
```
boolean isIterating()
```
    Indicate whether the query is defined inside the scope of FOR EACH block.
    
    Returns:
    
    true if the query was defined inside a FOR EACH block.
  - isPresort
```
boolean isPresort()
```
    Indicate whether the query is of presort type.
    
    Returns:
    
    true if the query is of presort type..
  - setPresort
```
void setPresort(boolean presort)
```
    Indicate whether the query is of presort type.
    
    Parameters:
    
    presort - true indicating that a query of presort type. false is not of presort type.
  - addAccumulator
```
void addAccumulator(Accumulator accum)
```
    Add an accumulator to this query. The accumulator expects to be notified whenever a new result row is accessed (during sequential row access).
    This implementation assumes the accumulator is not associated with a break group.
    
    Parameters:
    
    accum - Accumulator to be registered with this query.
  - addAccumulator
```
void addAccumulator(Accumulator accum,
                    boolean deferred)
```
    Add an accumulator to this query. The accumulator expects to be notified whenever a new result row is accessed (during sequential row access).
    This implementation assumes the accumulator is not associated with a break group.
    
    Parameters:
    
    accum - Accumulator to be registered with this query.
    
    deferred - true to defer accumulator recalculation until the next invocation of Accumulator.accumulate(). If false, the accumulator recalculates its internal state as soon as the query's next result is fetched.
  - first
```
boolean first()
```
    Retrieve the first composite row of results for the query. The underlying buffer for each query component is updated with the appropriate record.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Returns:
    
    true if query could retrive the first record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query or the fetch of any record fails, or if no records are available and the query is set to fail in this case.
    
    QueryOffEndException - if no records are available and the query is set not to fail in this case.
  - first
```
boolean first(LockType lockType)
```
    Retrieve the first composite row of results for the query. The underlying buffer for each query component is updated with the appropriate record.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    lockType - Lock type to apply to records retrieved (overrides default lock type set for each query component).
    
    Returns:
    
    true if query could retrive the first record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query or the fetch of any record fails, or if no records are available and the query is set to fail in this case.
    
    QueryOffEndException - if no records are available and the query is set not to fail in this case.
  - last
```
boolean last()
```
    Retrieve the last composite row of results for the query. The underlying buffer for each query component is updated with the appropriate record.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Returns:
    
    true if query could retrive the last record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query or the fetch of any record fails, or if no records are available and the query is set to fail in this case.
    
    QueryOffEndException - if no records are available and the query is set not to fail in this case.
  - last
```
boolean last(LockType lockType)
```
    Retrieve the last composite row of results for the query. The underlying buffer for each query component is updated with the appropriate record.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    lockType - Lock type to apply to records retrieved (overrides default lock type set for each query component).
    
    Returns:
    
    true if query could retrive the last record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query or the fetch of any record fails, or if no records are available and the query is set to fail in this case.
    
    QueryOffEndException - if no records are available and the query is set not to fail in this case.
  - next
```
boolean next()
```
    Retrieve the next composite row of results for the query. The underlying buffer for each query component is updated with the appropriate record.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Returns:
    
    true if query could retrive the next record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query or the fetch of any record fails, or if no records are available and the query is set to fail in this case.
    
    QueryOffEndException - if no records are available and the query is set not to fail in this case.
  - next
```
boolean next(LockType lockType)
```
    Retrieve the next composite row of results for the query. The underlying buffer for each query component is updated with the appropriate record.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    lockType - Lock type to apply to records retrieved (overrides default lock type set for each query component).
    
    Returns:
    
    true if query could retrive the next record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query or the fetch of any record fails, or if no records are available and the query is set to fail in this case.
    
    QueryOffEndException - if no records are available and the query is set not to fail in this case.
  - previous
```
boolean previous()
```
    Retrieve the previous composite row of results for the query. The underlying buffer for each query component is updated with the appropriate record.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Returns:
    
    true if query could retrive the previous record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query or the fetch of any record fails, or if no records are available and the query is set to fail in this case.
    
    QueryOffEndException - if no records are available and the query is set not to fail in this case.
  - previous
```
boolean previous(LockType lockType)
```
    Retrieve the previous composite row of results for the query. The underlying buffer for each query component is updated with the appropriate record.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    lockType - Lock type to apply to records retrieved (overrides default lock type set for each query component).
    
    Returns:
    
    true if query could retrive the previous record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query or the fetch of any record fails, or if no records are available and the query is set to fail in this case.
    
    QueryOffEndException - if no records are available and the query is set not to fail in this case.
  - unique
```
default boolean unique()
```
    Retrieve a unique record (only valid for a single-table query).
    
    Returns:
    
    true if query could retrive the unique record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query fails or if more than one result is found which matches the query criteria.
  - unique
```
default boolean unique(LockType lockType)
```
    Retrieve a unique record (only valid for a single-table query), overriding the default lock type of the underlying query component.
    
    Parameters:
    
    lockType - Lock type which should override that of the query component.
    
    Returns:
    
    true if query could retrive the unique record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the query fails or if more than one result is found which matches the query criteria.
  - current
```
boolean current()
```
    Reload the current composite row of results for the query.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Returns:
    
    true if query could retrive the current record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the reload triggers an error.
  - current
```
boolean current(LockType lockType)
```
    Reload the current composite row of results for the query, overriding the lock type to apply to each record.
    If the query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    lockType - Lock type which should override that of any query component.
    
    Returns:
    
    true if query could retrive the current record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if the reload triggers an error.
  - hasAny
```
logical hasAny()
```
    Indicate whether a request to find the first result of this query would succeed or fail.
    Default substitution arguments and a lock type of NONE are used for this test.
    
    Returns:
    
    true if the first record exists, else false.
  - hasAny
```
logical hasAny(java.lang.Object[] values)
```
    Indicate whether a request to find the first result of this query would succeed or fail.
    The specified substitution arguments and a lock type of NONE are used for this test.
    
    Parameters:
    
    values - Query substitution parameters.
    
    Returns:
    
    true if the first record exists, else false.
  - hasAny
```
logical hasAny(LockType lockType)
```
    Indicate whether a request to find the first result of this query would succeed or fail.
    Default substitution arguments and the specified lock type are used for this test.
    
    Parameters:
    
    lockType - Lock type for the query. This lock is not actually acquired, only tested for availability.
    
    Returns:
    
    true if the first record exists, else false.
  - hasAny
```
logical hasAny(java.lang.Object[] values,
               LockType lockType)
```
    Indicate whether a request to find the first result of this query would succeed or fail.
    The specified substitution arguments and lock type are used for this test.
    
    Parameters:
    
    values - Query substitution parameters.
    
    lockType - Lock type for the query. This lock is not actually acquired, only tested for availability.
    
    Returns:
    
    true if the first record exists, else false.
  - hasOne
```
logical hasOne()
```
    Indicate whether this query would produce a unique result.
    Default substitution arguments and a lock type of NONE are used for this test.
    
    Returns:
    
    true if any record matching the query's criteria exists, else false.
  - hasOne
```
logical hasOne(java.lang.Object[] values)
```
    Indicate whether this query would produce a unique result.
    The specified substitution arguments and a lock type of NONE are used for this test.
    
    Parameters:
    
    values - Query substitution parameters.
    
    Returns:
    
    true if any record matching the query's criteria exists, else false.
  - hasOne
```
logical hasOne(LockType lockType)
```
    Indicate whether this query would produce a unique result.
    Default substitution arguments and the specified lock type are used for this test.
    
    Parameters:
    
    lockType - Lock type for the query. This lock is not actually acquired, only tested for availability.
    
    Returns:
    
    true if any record matching the query's criteria exists, else false.
  - hasOne
```
logical hasOne(java.lang.Object[] values,
               LockType lockType)
```
    Indicate whether this query would produce a unique result.
    The specified substitution arguments and lock type are used for this test.
    
    Parameters:
    
    values - Query substitution parameters.
    
    lockType - Lock type for the query. This lock is not actually acquired, only tested for availability.
    
    Returns:
    
    true if any record matching the query's criteria exists, else false.
  - isFirstOfGroup
```
default logical isFirstOfGroup(integer level)
```
    Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria. Must not be unknown value.
    
    Returns:
    
    true if the current row is first in the result set or within the specified break group; else false.
  - isFirstOfGroup
```
default logical isFirstOfGroup(int level)
```
    Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria.
    
    Returns:
    
    true if the current row is first in the result set or within the specified break group; else false.
  - isLastOfGroup
```
default logical isLastOfGroup(integer level)
```
    Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria. Must not be unknown value.
    
    Returns:
    
    true if the current row is last in the result set or within the specified break group; else false.
  - isLastOfGroup
```
default logical isLastOfGroup(int level)
```
    Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria.
    
    Returns:
    
    true if the current row is last in the result set or within the specified break group; else false.
  - repositionByID
```
void repositionByID(recid id)
```
    Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified primary key ID. A request to retrieve the previous result will retrieve the result immediately previous to this, if any, in the results list.
    
    Parameters:
    
    id - A primary key ID, representing the target record (in the case of a join, this ID is associated with the left-most record in the join).
    
    Throws:
    
    ErrorConditionException - if the specified ID represents the unknown value.
  - repositionByID
```
void repositionByID(rowid id1,
                    rowid... joinIDs)
```
    Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs. A request to retrieve the previous result will retrieve the result immediately previous to this, if any, in the results list.
    
    Parameters:
    
    id1 - A primary key ID, representing the target record (in the case of a join, this ID is associated with the left-most record in the join).
    
    joinIDs - All remaining primary key IDs, if any, arranged from left to right to coincide with the records being joined by the underlying query.
    
    Throws:
    
    ErrorConditionException - if any of the specified IDs represents the unknown value.
  - repositionByID
```
boolean repositionByID(java.lang.Long... joinIDs)
```
    Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs. A request to retrieve the previous result will retrieve the result immediately previous to this, if any, in the results list. Note: This is not public API.
    
    Parameters:
    
    joinIDs - A set of primary key IDs, arranged from left to right to coincide with the records being joined by the underlying query.
    
    Returns:
    
    true on success.
    
    Throws:
    
    ErrorConditionException - if any of the specified IDs represents the unknown value.
  - reposition
```
void reposition(NumberType row)
```
    Reposition the cursor to the specified row in the result set. The row indicates the position between two results, such that a call to retrieve the next record will get the result at the specified row, and a call to retrieve the previous result will get the result before the new position.
    
    Parameters:
    
    row - 1-based index of the target position.
    
    Throws:
    
    ErrorConditionException - if row represents unknown value.
  - reposition
```
void reposition(int row)
```
    Reposition the query to the specified row in the result set. The row indicates the position between two results, such that a call to retrieve the next record will get the record after the new position, and a call to retrieve the previous record will get the record before the new position.
    
    Parameters:
    
    row - 1-based index of the target position.
  - forward
```
boolean forward(NumberType rows)
```
    Advance the current cursor position forward by the specified number of rows. This will always leave the cursor between two results. For example, given a request to move 1 row forward:
    - if the cursor currently is positioned directly on a result, this would move it ahead one and a half positions, to just beyond the following result;
    - if the cursor currently is positioned between two results, this would move it ahead one position, to just beyond the following result.
    Parameters:
    
    rows - Number of rows to scroll the cursor forward.
    
    Returns:
    
    true if operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
    
    Throws:
    
    ErrorConditionException - if rows represents the unknown value.
  - forward
```
boolean forward(int rows)
```
    Advance the current cursor position forward by the specified number of rows. This will always leave the cursor between two results. For example, given a request to move 1 row forward:
    - if the cursor currently is positioned directly on a result, this would move it ahead one and a half positions, to just beyond the following result;
    - if the cursor currently is positioned between two results, this would move it ahead one position, to just beyond the following result.
    Parameters:
    
    rows - Number of rows to scroll the cursor forward.
    
    Returns:
    
    true if operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
  - backward
```
boolean backward(NumberType rows)
```
    Move the current cursor position backward by the specified number of rows. This will always leave the cursor between two results. For example, given a request to move 1 row backward:
    - if the cursor currently is positioned directly on a result, this would move it back one half position, to just before the current result;
    - if the cursor currently is positioned between two results, this would move it back one position, to just before the current result.
    Parameters:
    
    rows - Number of rows to scroll the cursor backward.
    
    Returns:
    
    true if operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
    
    Throws:
    
    ErrorConditionException - if rows represents the unknown value.
  - backward
```
boolean backward(int rows)
```
    Move the current cursor position backward by the specified number of rows. This will always leave the cursor between two results. For example, given a request to move 1 row backward:
    - if the cursor currently is positioned directly on a result, this would move it back one half position, to just before the current result;
    - if the cursor currently is positioned between two results, this would move it back one position, to just before the current result.
    Parameters:
    
    rows - Number of rows to scroll the cursor backward.
    
    Returns:
    
    true if operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
  - size
```
integer size()
```
    Get the current size of the cached results list. However, since this cache may be built progressively as the query is scrolled, repositioned, and naturally navigated, this does not necessarily represent the full count of results which may satisfy the query.
    
    Returns:
    
    Current results list size or unknown value if the query is not open.
  - currentRow
```
integer currentRow()
```
    Progress-compatible function that returns the 1-based index of the current row in the result set. This is the index of the entry at or before which the cursor currently is positioned.
    
    Returns:
    
    Unknown value if the query is not open or result set is empty. 1 if the query is positioned before the first record. A value 1 greater than the number of rows in the query result set if the query is positioned beyond the last record. Otherwise returns the number of rows in the query result set.
  - currentRowImpl
```
integer currentRowImpl()
```
    Get the 1-based index of the current row in the result set. This is the index of the entry at or before which the cursor currently is positioned.
    
    Returns:
    
    Current row or the unknown value if the current row cannot be determined. The current row cannot be determined if the results list is empty, or if the cursor currently is in backward scroll mode.
  - isOffEnd
```
logical isOffEnd()
```
    Indicate whether the cursor has run off one or the other end of the associated query's list of available results. If true, this indicates that the query cannot produce any more results in the current scroll direction.
    
    Returns:
    
    true if the cursor is off either end of its query's results list.
  - _isOffEnd
```
boolean _isOffEnd()
```
    Indicate whether the cursor has run off one or the other end of the associated query's list of available results. If true, this indicates that the query cannot produce any more results in the current scroll direction.
    
    Returns:
    
    true if the cursor is off either end of its query's results list.
  - getOffEnd
```
OffEnd getOffEnd()
```
    Get the off-end status of this query, which indicates whether the query has run off either end of its results.
    
    Returns:
    
    One of the OffEnd constants NONE, FRONT, or BACK.
  - isPreselect
```
boolean isPreselect()
```
    Indicate whether this query preselects all of its results.
    
    Returns:
    
    true if the query preselects its results; false if the query's results are dynamically navigated.
  - isFindByRowid
```
default boolean isFindByRowid()
```
    Indicate whether this query is a simple RECID/ROWID lookup FIND query. This has implications as to whether a 7254 error will be raised in the event this FIND is nested within a function called within another query's WHERE clause.
    
    Returns:
    
    true if this is a RECID/ROWID lookup FIND query, else false. This default implementation returns false.
  - isNativelyPreselect
```
boolean isNativelyPreselect()
```
    Indicate whether this query is a preselect query by its nature.
    
    Returns:
    
    true.
  - isFetchOnReposition
```
boolean isFetchOnReposition()
```
    Is this query set to fetch the next record after a reposition?
    
    Returns:
    
    true if set to fetch after reposition, else false.
  - setFetchOnReposition
```
void setFetchOnReposition(boolean enable)
```
    Set this query to automatically fetch the next record after a reposition, or turn this feature off.
    
    Parameters:
    
    enable - true to enable automatic fetching; false to disable.
  - addRepositionListener
```
void addRepositionListener(RepositionListener listener)
```
    Register a listener to receive notifications reposition events for this query.
    
    Parameters:
    
    listener - Reposition listener to be registered.
  - removeRepositionListener
```
void removeRepositionListener(RepositionListener listener)
```
    Unregister a listener that was receiving notifications on reposition events for this query.
    
    Parameters:
    
    listener - Reposition listener to be unregistered.
  - notifyRepositionListeners
```
void notifyRepositionListeners(boolean closed,
                               boolean error,
                               int targetRepositionRow)
```
    Notify all registered listeners that query is repositioned or closed.
    
    Parameters:
    
    closed - A true value will inform all listeners that the query was explicitly closed.
    
    error - true if an error happened during reposition.
    
    targetRepositionRow - Row used as the target for reposition. If it was deleted, reposition with fetching may end up on a different row.
  - setBrowsed
```
void setBrowsed(boolean browsed)
```
    Indicate to this query that whether it is associated with a browse widget or not.
    
    Parameters:
    
    browsed - true to indicate the query has an associated browse widget, else false.
  - isBrowsed
```
boolean isBrowsed()
```
    Is this query associated with a browse widget or not?
    
    Returns:
    
    true if the query has an associated browse widget,
  - isStandalone
```
boolean isStandalone()
```
    Indicate whether this query stands alone, or is the component of another query, or is wrapped by a query wrapper.
    
    Returns:
    
    true if standalone, else false.
  - setStandalone
```
void setStandalone(boolean standalone)
```
    Change the standalone nature of this query. A query is standalone by default, but can be changed to non-standalone by the wrapper or container which contains it.
    
    Parameters:
    
    standalone - true to set query as standalone; false to set query as contained.
  - cleanup
```
void cleanup()
```
    Clean up resources associated with this query when its scope ends.
  - queryClose
```
logical queryClose()
```
    Conversion of QUERY-CLOSE() method (KW_QRY_CLOS). Closes a query object.
    
    Returns:
    
    true if QUERY-CLOSE() succeeds, else false.
  - queryBackward
```
logical queryBackward(int rows)
```
    Conversion of REPOSITION-BACKWARD() method (KW_REPOS_B). Moves a query object's result list pointer backward a particular number of rows.
    
    Returns:
    
    true if REPOSITION-BACKWARD() succeeds, else false.
  - queryBackward
```
logical queryBackward(NumberType rows)
```
    Conversion of REPOSITION-BACKWARD() method (KW_REPOS_B). Moves a query object's result list pointer backward a particular number of rows.
    
    Returns:
    
    true if REPOSITION-BACKWARD() succeeds, else false.
  - queryForward
```
logical queryForward(int rows)
```
    Conversion of REPOSITION-FORWARD() method (KW_REPOS_F). Moves a query object's result list pointer forward a particular number of rows.
    
    Returns:
    
    true if REPOSITION-FORWARD() succeeds, else false.
  - queryForward
```
logical queryForward(NumberType rows)
```
    Conversion of REPOSITION-FORWARD() method (KW_REPOS_F). Moves a query object's result list pointer forward a particular number of rows.
    
    Returns:
    
    true if REPOSITION-FORWARD() succeeds, else false.
  - queryReposition
```
logical queryReposition(int n)
```
    Conversion of REPOSITION-TO-ROW() method (KW_REPOS_2R). Moves a query object's result list pointer to the row corresponding to the specified sequence number.
    
    Parameters:
    
    n - An integer expression representing the sequence number.
    
    Returns:
    
    true if REPOSITION-TO-ROW() succeeds, else false.
  - queryReposition
```
logical queryReposition(NumberType n)
```
    Conversion of REPOSITION-TO-ROW() method (KW_REPOS_2R). Moves a query object's result list pointer to the row corresponding to the specified sequence number.
    
    Parameters:
    
    n - An integer expression representing the sequence number.
    
    Returns:
    
    true if REPOSITION-TO-ROW() succeeds, else false.
  - queryRepositionByID
```
logical queryRepositionByID(rowid id1,
                            rowid... joinIDs)
```
    Conversion of REPOSITION-TO-ROWID() method (KW_REPOS_2I). Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs. A request to retrieve the previous result will retrieve the result immediately previous to this, if any, in the results list.
    
    Parameters:
    
    id1 - A primary key ID, representing the target record (in the case of a join, this ID is associated with the left-most record in the join).
    
    joinIDs - All remaining primary key IDs, if any, arranged from left to right to coincide with the records being joined by the underlying query.
    
    Returns:
    
    true if REPOSITION-TO-ROWID() succeeds, else false.
  - queryRepositionByID
```
default logical queryRepositionByID(character rowId)
```
    Conversion of REPOSITION-TO-ROWID() method (KW_REPOS_2I). Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs. A request to retrieve the previous result will retrieve the result immediately previous to this, if any, in the results list.
    
    Parameters:
    
    rowId - A character representation of this rowid.
    
    Returns:
    
    true if REPOSITION-TO-ROWID() succeeds, else false.
  - getNumResults
```
integer getNumResults()
```
    Conversion of NUM-RESULTS attribute (KW_NUM_RES). Getter of NUM-RESULTS attribute
  - prepare
```
logical prepare(java.lang.String predicate)
```
    Compiles a predicate (query condition). This method is the equivalent of QUERY-PREPARE() method from 4GL.
    
    Parameters:
    
    predicate - The predicate to be prepared by this query.
    
    Returns:
    
    true on success
  - prepare
```
logical prepare(character predicate)
```
    Compiles a predicate (query condition). This method is the equivalent of QUERY-PREPARE() method from 4GL.
    
    Parameters:
    
    predicate - The predicate to be prepared by this query.
    
    Returns:
    
    true on success
  - queryOpen
```
logical queryOpen()
```
    Opens a query object. This method is the equivalent of QUERY-OPEN() method from 4GL. Note: You must perform prepare() on a query object before you perform queryOpen on it.
    
    Returns:
    
    true on success
  - indexInformation
```
character indexInformation()
```
    Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO). Getter of INDEX-INFORMATION attribute
    
    Specified by:
    
    indexInformation in interface IndexInformation
    
    Returns:
    
    A character string consisting of a comma-separated list of the index or indexes the query uses at the level of join specified.
  - indexInformation
```
character indexInformation(int n)
```
    Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO). Getter of INDEX-INFORMATION attribute
    
    Specified by:
    
    indexInformation in interface IndexInformation
    
    Parameters:
    
    n - An integer expression that evaluates to the level of join for which you want index information.
    
    Returns:
    
    A character string consisting of a comma-separated list of the index or indexes the query uses at the level of join specified.
  - indexInformation
```
character indexInformation(NumberType n)
```
    Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO). Getter of INDEX-INFORMATION attribute
    
    Specified by:
    
    indexInformation in interface IndexInformation
    
    Parameters:
    
    n - An integer expression that evaluates to the level of join for which you want index information.
    
    Returns:
    
    A character string consisting of a comma-separated list of the index or indexes the query uses at the level of join specified.
  - forwardOnly
```
logical forwardOnly()
```
    Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY). Getter of FORWARD-ONLY attribute.
    
    Returns:
    
    current value of FORWARD-ONLY attribute.
  - changeForwardOnly
```
void changeForwardOnly(logical forwardOnly)
```
    Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY). Setter of FORWARD-ONLY attribute.
    
    Parameters:
    
    forwardOnly - New value of FORWARD-ONLY attribute.
  - changeForwardOnly
```
void changeForwardOnly(boolean forwardOnly)
```
    Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY). Setter of FORWARD-ONLY attribute.
    
    Parameters:
    
    forwardOnly - New value of FORWARD-ONLY attribute.
  - prepareString
```
character prepareString()
```
    Conversion of PREPARE_STRING attribute (KW_PREP_STR). Getter of PREPARE_STRING attribute.
    
    Returns:
    
    current value of PREPARE_STRING attribute.
  - getCache
```
integer getCache()
```
    Getter for the CACHE attribute.
    
    Returns:
    
    See above.
  - setCache
```
void setCache(integer n)
```
    Setter for the CACHE attribute.
    
    Parameters:
    
    n - The cache value.
  - setCache
```
void setCache(long n)
```
    Setter for the CACHE attribute.
    
    Parameters:
    
    n - The cache value.
  - getNext
```
default logical getNext()
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Returns:
    
    true if the next record in the query is found. If the query is not open or the next record cannot be found (query is empty or the query result list pointer is on the last row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
  - _getNext
```
boolean _getNext()
```
    Conversion of GET-NEXT method (KW_GET_NEXT), which returns a Java boolean, for internal usage. Moves a query object's result list pointer ahead one row.
    
    Returns:
    
    true if the next record in the query is found. If the query is not open or the next record cannot be found (query is empty or the query result list pointer is on the last row), the method returns false.
  - getNext
```
logical getNext(LockType lockType)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Parameters:
    
    lockType - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the next record in the query is found. If the query is not open or the next record cannot be found (query is empty or the query result list pointer is on the last row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
  - getNext
```
logical getNext(long lock)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the next record in the query is found. If the query is not open or the next record cannot be found (query is empty or the query result list pointer is on the last row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getNext
```
logical getNext(NumberType lock)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the next record in the query is found. If the query is not open or the next record cannot be found (query is empty or the query result list pointer is on the last row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getNext
```
logical getNext(long lock,
                long nowait)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the next record in the query is found. If the query is not open or the next record cannot be found (query is empty or the query result list pointer is on the last row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getNext
```
logical getNext(long lock,
                NumberType nowait)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the next record in the query is found. If the query is not open or the next record cannot be found (query is empty or the query result list pointer is on the last row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getNext
```
logical getNext(NumberType lock,
                long nowait)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the next record in the query is found. If the query is not open or the next record cannot be found (query is empty or the query result list pointer is on the last row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getNext
```
logical getNext(NumberType lock,
                NumberType nowait)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the next record in the query is found. If the query is not open or the next record cannot be found (query is empty or the query result list pointer is on the last row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getPrevious
```
logical getPrevious()
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Returns:
    
    true if the previous record in the query is found. If the query is not open or the previous record cannot be found (query is empty or the query result list pointer is on the first row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
  - getPrevious
```
logical getPrevious(long lock)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the previous record in the query is found. If the query is not open or the previous record cannot be found (query is empty or the query result list pointer is on the first row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getPrevious
```
logical getPrevious(LockType lockType)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Parameters:
    
    lockType - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the previous record in the query is found. If the query is not open or the previous record cannot be found (query is empty or the query result list pointer is on the first row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getPrevious
```
logical getPrevious(NumberType lock)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the previous record in the query is found. If the query is not open or the previous record cannot be found (query is empty or the query result list pointer is on the first row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getPrevious
```
logical getPrevious(long lock,
                    long nowait)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the previous record in the query is found. If the query is not open or the previous record cannot be found (query is empty or the query result list pointer is on the first row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getPrevious
```
logical getPrevious(NumberType lock,
                    long nowait)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the previous record in the query is found. If the query is not open or the previous record cannot be found (query is empty or the query result list pointer is on the first row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getPrevious
```
logical getPrevious(long lock,
                    NumberType nowait)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the previous record in the query is found. If the query is not open or the previous record cannot be found (query is empty or the query result list pointer is on the first row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getPrevious
```
logical getPrevious(NumberType lock,
                    NumberType nowait)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the previous record in the query is found. If the query is not open or the previous record cannot be found (query is empty or the query result list pointer is on the first row), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getFirst
```
logical getFirst()
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Returns:
    
    true if the first record in the query is found. If the query is not open or the first record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
  - getFirst
```
logical getFirst(long lock)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the first record in the query is found. If the query is not open or the first record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getFirst
```
logical getFirst(NumberType lock)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the first record in the query is found. If the query is not open or the first record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getFirst
```
logical getFirst(LockType lockType)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Parameters:
    
    lockType - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the first record in the query is found. If the query is not open or the first record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getFirst
```
logical getFirst(long lock,
                 long nowait)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the first record in the query is found. If the query is not open or the first record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getFirst
```
logical getFirst(NumberType lock,
                 long nowait)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the first record in the query is found. If the query is not open or the first record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getFirst
```
logical getFirst(long lock,
                 NumberType nowait)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the first record in the query is found. If the query is not open or the first record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getFirst
```
logical getFirst(NumberType lock,
                 NumberType nowait)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the first record in the query is found. If the query is not open or the first record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getLast
```
logical getLast()
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Returns:
    
    true if the last record in the query is found. If the query is not open or the last record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
  - getLast
```
logical getLast(long lock)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the last record in the query is found. If the query is not open or the last record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getLast
```
logical getLast(NumberType lock)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the last record in the query is found. If the query is not open or the last record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getLast
```
logical getLast(LockType lockType)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Parameters:
    
    lockType - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if the last record in the query is found. If the query is not open or the last record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - getLast
```
logical getLast(long lock,
                long nowait)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the last record in the query is found. If the query is not open or the last record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getLast
```
logical getLast(NumberType lock,
                long nowait)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the last record in the query is found. If the query is not open or the last record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getLast
```
logical getLast(long lock,
                NumberType nowait)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the last record in the query is found. If the query is not open or the last record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getLast
```
logical getLast(NumberType lock,
                NumberType nowait)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if the last record in the query is found. If the query is not open or the last record cannot be found (query is empty), the method returns false. If the query object handle is invalid, the method returns the Unknown value (?).
    
    Throws:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getCurrent
```
logical getCurrent()
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches the current record or records associated with the query.
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - getCurrent
```
logical getCurrent(long lock)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches the current record or records associated with the query.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - getCurrent
```
logical getCurrent(NumberType lock)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches the current record or records associated with the query.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - getCurrent
```
logical getCurrent(LockType lockType)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches the current record or records associated with the query.
    
    Parameters:
    
    lockType - Lock type
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - getCurrent
```
logical getCurrent(long lock,
                   long nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches the current record or records associated with the query.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - getCurrent
```
logical getCurrent(NumberType lock,
                   long nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches the current record or records associated with the query.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - getCurrent
```
logical getCurrent(long lock,
                   NumberType nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches the current record or records associated with the query.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - getCurrent
```
logical getCurrent(NumberType lock,
                   NumberType nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches the current record or records associated with the query.
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - setSkipDeletedRecord
```
void setSkipDeletedRecord(logical on)
```
    Setter for SKIP-DELETED-RECORD query attribute.
    
    Parameters:
    
    on - New value for the attribute.
  - isSkipDeletedRecord
```
logical isSkipDeletedRecord()
```
    Get value of SKIP-DELETED-RECORD attribute of the query.
    
    Returns:
    
    the value of SKIP-DELETED-RECORD attribute of the query.
  - include
```
void include(DataModelObject dmo,
             java.lang.String... fields)
```
    Specifies the fields included in a record retrieval.
    
    Parameters:
    
    dmo - DMO proxy which defines the buffer for which the fields are specified.
    
    fields - The fields included in a record retrieval. If no fields are specified, only record identifiers are retrieved. No subscripts can be specified for extent fields.
  - exclude
```
void exclude(DataModelObject dmo,
             java.lang.String... fields)
```
    Specifies the fields excluded from a record retrieval.
    
    Parameters:
    
    dmo - DMO proxy which defines the buffer for which the fields are specified.
    
    fields - The fields excluded from a record retrieval. If no fields are specified, complete records are retrieved. No subscripts can be specified for extent fields.
  - deleteResultListEntry
```
logical deleteResultListEntry()
```
    Deletes the current row of a query's result list. Implements the 4GL DELETE-RESULT-LIST-ENTRY() method.
    
    Returns:
    
    true on success.
  - deleteResultListEntry
```
logical deleteResultListEntry(boolean allowBetweenRows)
```
    Deletes the current row of a query's result list. Implements the 4GL DELETE-RESULT-LIST-ENTRY() method.
    
    Parameters:
    
    allowBetweenRows - If true then the cursor can be positioned between rows (the next row will be deleted). false for conventional DELETE-RESULT-LIST-ENTRY() mode where the cursor should be positioned on a row (otherwise false is returned).
    
    Returns:
    
    true on success.
  - createResultListEntry
```
logical createResultListEntry()
```
    Creates an entry in the result list for the current row. Implements the 4GL CREATE-RESULT-LIST-ENTRY() method. Created entry contains id(s) of the record(s) currently located in the backing buffer(s).
    
    Returns:
    
    true on success.
  - setParameterFilter
```
void setParameterFilter(ParameterFilter parameterFilter)
```
    Set the filter that handles parameters passed to the query. E.g. it can take input field references and substitute them with snapshot values, if necessary.
    
    Parameters:
    
    parameterFilter - The filter that handles passed parameters.
  - releaseBuffers
```
void releaseBuffers()
```
    Releases the buffers controlled by this query. The position of this query is not affected.
  - addDynamicFilter
```
boolean addDynamicFilter(FieldReference fr,
                         BaseDataType val,
                         java.lang.String format)
```
    Adds a new constraint term to the where predicate of this query, effectively filtering out any rows whose referenced field does not match the requested value. Semantically, the query will select rows that match
    new-where := (fr = val) AND (old-query).
    Note: The constraints are exclusive meaning that if constraints will be added for same field of same buffer, the query will return an empty result because the field cannot be at the same time equals to two different values.
    Use clearDynamicFilters() to clean all dynamically added criteria and restore the sorting order of the query to its original form.
    
    Parameters:
    
    fr - A reference to field used as filtering criterion. Only the rows that matches the specified value for this field will be selected. Must not be null.
    
    val - The filtering value for this constraint. Can be null or unknown, in which case the SQL null value will be assumed. In this case the predicate will look like:
    new-where := (fr IS NULL) AND (old-query)
    
    format - The format to be used when comparing values. The reason for this parameter is that for some datatype (ex: decimal) the on-screen value can be different from the database (because of rounding).
    
    Returns:
    
    true if the filtering constraint was successfully added. If the field reference is not related to the buffer(s) of this query, false is returned.
  - clearDynamicFilters
```
void clearDynamicFilters()
```
    Clears any dynamically filters added at runtime. The query predicate will be restored to its form from generated at conversion time.
  - hintFullResults
```
default void hintFullResults()
```
    Mark the query to retrieve the entire result set (useful for FILL operations).
  - addQueryEventListener
```
default void addQueryEventListener(P2JQuery.QueryEventListener qel)
```
    Adds a listener to be notified when this query is opened or closed.
    Note that this method is only called for dynamic queries only (for the moment).
    
    Parameters:
    
    qel - The listener to be notified.
  - notifyQueryOpenListeners
```
default void notifyQueryOpenListeners(boolean evaluate)
```
    Notifies the registered QUERY-OPEN listeners that the even is about to happen.
    
    Parameters:
    
    evaluate - Flag indicating that the dynamic query must evaluate its dynamic calls (like DYNAMIC-FUNCTION) in the WHERE clause.
  - notifyQueryCloseListeners
```
default void notifyQueryCloseListeners()
```
    Notifies the registered QUERY-CLOSE listeners that the even is about to happen.
  - getBasicLogging
```
default logical getBasicLogging()
```
    Getter for the BASIC-LOGGING attribute.
    
    Returns:
    
    See above.
  - setBasicLogging
```
default void setBasicLogging(logical val)
```
    Setter for the BASIC-LOGGING attribute.
    
    Parameters:
    
    val - Flag activating or deactivating the logging.
  - setBasicLogging
```
default void setBasicLogging(boolean val)
```
    Setter for the BASIC-LOGGING attribute.
    
    Parameters:
    
    val - Flag activating or deactivating the logging.
  - setFillingBrowseRows
```
default void setFillingBrowseRows(boolean on)
```
    Informs the query that the next operations will be performed for filling browse rows, so it should not return deleted rows/records (if argument is true). That is, temporarily overwrite the SKIP-DELETED-RECORDS until the flag is turned off.
    The default implementation does nothing.
    
    Parameters:
    
    on - if true the deleted rows will not be returned because the query is managed by the browse widget.
  - isFillingBrowseRows
```
default boolean isFillingBrowseRows()
```
    Test whether the flag was set.
    
    Returns:
    
    true during the returning of rows for populating a browse widget.
    
    See Also:
    
    setFillingBrowseRows(boolean)
  - getDataRelation
```
default DataRelation getDataRelation()
```
    Get the recursive DATA-RELATION the query is to FILL for.
    
    Returns:
    
    the recursive DATA-RELATION the query is to FILL for
  - setDataRelation
```
default void setDataRelation(DataRelation relation)
```
    Set the recursive DATA-RELATION the query is to FILL for.
    
    Parameters:
    
    relation - the recursive DATA-RELATION the query is to FILL for

Interface P2JQuery

Nested Class Summary

Method Summary

Methods inherited from interface com.goldencode.p2j.persist.BufferCollection

Methods inherited from interface com.goldencode.p2j.util.Openable

Method Detail

clearResults

setDynamicPredicate

isDynamicPredicate

setScrolling

isScrolling

setIndexedReposition

isIndexedReposition

open

close

close

resetQuery

getTableCount

getRecordBuffers

addExternalBuffers

getJoin

getOffEndListeners

setErrorIfNull

setLenientOffEnd

setIterating

isIterating

isPresort

setPresort

addAccumulator

addAccumulator

first

first

last

last

next

next

previous

previous

unique

unique

current

current

hasAny

hasAny

hasAny

hasAny

hasOne

hasOne

hasOne

hasOne

isFirstOfGroup

isFirstOfGroup

isLastOfGroup

isLastOfGroup

repositionByID

repositionByID

repositionByID

reposition

reposition

forward

forward

backward

backward

size

currentRow

currentRowImpl

isOffEnd

_isOffEnd

getOffEnd

isPreselect

isFindByRowid

isNativelyPreselect

isFetchOnReposition

setFetchOnReposition

addRepositionListener

removeRepositionListener

notifyRepositionListeners

setBrowsed

isBrowsed

isStandalone