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

java.lang.Object
- com.goldencode.p2j.persist.AbstractQuery

All Implemented Interfaces:

BufferCollection, IndexInformation, P2JQuery, Openable

Direct Known Subclasses:

DynamicQuery, PreselectQuery
```
public abstract class AbstractQuery
extends java.lang.Object
implements P2JQuery
```
Abstract base class for all query implementation classes. Implements the Joinable interface and provides base services common to all query implementations.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.goldencode.p2j.persist.P2JQuery
  P2JQuery.Parameter, P2JQuery.ParamResolver, P2JQuery.QueryEventListener, P2JQuery.QueryOpenedListener

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.LinkedHashMap<Accumulator,java.lang.Boolean>`	`accumulators` Accumulators added to this query, mapped to their deferred status
`private boolean`	`browsed` Is query associated with a UI browse widget?
`protected boolean`	`closed` Flag indicating if this query was explicitly closed.
`protected boolean`	`dynamicPredicate` Flag indicating this query is associated with a dynamically prepared query resource.
`protected ErrorManager.ErrorHelper`	`errorHelper` Context-local error helper used for silent mode operations.
`private boolean`	`errorIfNull` Should the failed first/last/unique retrievals raise error?
`private java.util.List<P2JQuery.QueryEventListener>`	`eventListeners` Registry of listeners who are notified of query is about to (re-)open.
`protected java.util.Map<DataModelObject,Property[]>`	`excluded` The excluded properties for each DMO (EXCEPT option).
`private RecordBuffer[]`	`externalBuffers` Set of external buffers, if any, referenced by this query
`private RecordBuffer[]`	`externalBuffersDefs` Set of external buffer definitions, if any, referenced by this query
`private boolean`	`fatalError` Flag indicating fatal error was encountered processing query substitution parameters
`private boolean`	`fetchOnReposition` Should the next row be fetched after a reposition?
`private boolean`	`fillingBrowseRows` This flags brackets the code which is invoked by browse widgets for populating its rows.
`private boolean`	`ignoreAfterRepo` Flag indicating if `afterReposition(boolean)` calls are skipped.
`protected java.util.Map<DataModelObject,Property[]>`	`included` The included properties for each DMO (FIELDS option).
`protected boolean`	`indexedReposition` Flag to indicate if this query is optimized using indexed reposition
`protected boolean`	`inverseSorting` Indicates whether the query has the inverse sorting direction against the original sorting.
`private boolean`	`iterating` Flag indicating whether the query is used inside a FOR EACH block.
`protected boolean`	`lenientOffEnd` `false` if running off end of results should raise error
`private static CentralLogger`	`LOG` Logger
`private boolean`	`notificationActive` Flag to avoid infinite recursion in reposition notification
`private boolean`	`omitAlias` Flag indicating that a DMO alias should not be used in this query's FQL statement
`protected boolean`	`outer` Marks this as a left outer join component of the query.
`protected ParameterFilter`	`parameterFilter` The filter that handles parameters passed to the query.
`private boolean`	`presort` Flag indicating whether the BREAK BY statement is present
`private DataRelation`	`relation` The recursive DATA-RELATION the query is to FILL for
`private WeakList<RepositionListener>`	`repoRegistry` Registry of listeners who are notified of query repositions
`private boolean`	`skipDeletedRecord` Internal value of SKIP-DELETED-RECORD.
`private boolean`	`standalone` Does this query stand alone or is it contained by a query wrapper ?

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractQuery()
Default constructor.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractQuery()` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`(package private) boolean`	`_isSkipDeletedRecord()` Test whether the SKIP-DELETED-RECORD attribute is set.
`protected void`	`accumulate()` Notify accumulators attached to this query (if any) that a new result row has been accessed, and that they should update their internal state.
`private void`	`accumulate(Accumulator accum, boolean deferred)` Invoke the appropriate `iterate` method variant on the specified accumulator.
`void`	`addAccumulator(Accumulator accum)` Add an accumulator to this query.
`void`	`addAccumulator(Accumulator accum, boolean deferred)` Add an accumulator to this query.
`logical`	`addBuffer(Buffer buf)` Adds one new buffer to a query object or dynamic DataSet object, without affecting the other buffers, if any.
`logical`	`addBuffer(handle bufHandle)` Adds one new buffer to a query object or dynamic DataSet object, without affecting the other buffers, if any.
`P2JQuery`	`addExternalBuffers(DataModelObject... dmos)` Add one or more buffers to the list of those which this query references externally.
`void`	`addQueryEventListener(P2JQuery.QueryEventListener listener)` Adds a listener to be notified when this query is open.
`void`	`addRepositionListener(RepositionListener listener)` Register a listener to receive notifications reposition events for this query.
`protected void`	`afterReposition(boolean permitFetch)` This method should be called by subclasses after any reposition of the query.
`protected void`	`afterReposition(boolean permitFetch, boolean error)` This method should be called by subclasses after any reposition of the query.
`protected void`	`afterReposition(boolean permitFetch, integer oldCurrentRow)` This method should be called by subclasses after any reposition of the query.
`handle`	`bufferHandle()` Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH).
`handle`	`bufferHandle(character bufferName)` Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH).
`handle`	`bufferHandle(int bufferSequenceNumber)` Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH).
`handle`	`bufferHandle(int64 bufferSequenceNumber)` Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH).
`handle`	`bufferHandle(java.lang.String bufferName)` Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH).
`protected static boolean`	`buffersMatch(RecordBuffer buf, RecordBuffer defBuf)` Check if the two buffers differ.
`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`	`close()` Explicitly close the prepared query.
`private void`	`collectFields(java.util.Map<DataModelObject,Property[]> target, DataModelObject dmo, java.lang.String[] fields, RecordBuffer buffer)` Populate the map of with the ORM properties specified in the given fields.
`logical`	`createResultListEntry()` Creates an entry in the result list for the current row.
`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.
`logical`	`forwardOnly()` Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY).
`private static LockType`	`fromLockNowait(long lock, long nowait)` Return the `LockType` instance for the given internal lock and nowait with corresponding query processing.
`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).
`DataRelation`	`getDataRelation()` Get the recursive DATA-RELATION the query is to FILL for.
`protected LockType`	`getDefaultLock()` Get the default lock type for this query.
`protected ErrorManager.ErrorHelper`	`getErrorHelper()` Retrieve the context-local error helper used for silent mode operations.
`protected RecordBuffer[]`	`getExternalBuffers()` Get the external buffers, if any, associated with this query.
`protected RecordBuffer[]`	`getExternalBuffersDefs()` Get the external buffers definitions, if any, associated with this query.
`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).
`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).
`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).
`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).
`RecordBuffer[]`	`getReferencedBuffers()` Get an array of all record buffers referenced by this query, including those directly involved in the query, as well as those (if any) indirectly referenced by inlined, converted, CAN-FIND expressions, and that which represents the inverse buffer of a natural join.
`protected boolean`	`hasAccumulators()` Check if query has attached accumulators.
`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.
`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()` Report whether this query is associated with a browse widget.
`boolean`	`isDynamicPredicate()` Check if this query is originating from a dynamic predicate.
`protected boolean`	`isErrorIfNull()` Indicate whether failed `FIRST`, `LAST`, and `UNIQUE` retrieval attempts should be considered an error condition.
`protected boolean`	`isFatalError()` Indicate whether there was a fatal error during query substitution parameter processing which should abort this query at the earliest appropriate time.
`boolean`	`isFetchOnReposition()` Is this query set to fetch the next record after a reposition?
`boolean`	`isFillingBrowseRows()` Test whether the flag was set.
`boolean`	`isIndexedReposition()` Disable indexed reposition optimization to disallow repositioning to unflushed records.
`boolean`	`isIterating()` Indicate whether the query is defined inside the scope of FOR EACH block.
`protected boolean`	`isLastOfBreakGroup(Resolvable key)` Determine whether the query result row currently being visited is the last row within a break group whose category is identified by the specified resolvable object.
`protected boolean`	`isLenientOffEnd()` Indicate whether this query will throw a `QueryOffEndException` when it runs off the end of its results.
`protected boolean`	`isNewBreakGroup(Resolvable key)` Subclasses which support the concept of break groups in query results should override this method to report whether the current result row being visited represents a new break group, for the given break group key.
`logical`	`isOffEnd()` Indicate whether the cursor has run off one or the other end of the associated query's list of available results.
`protected boolean`	`isOmitAlias()` Determine whether DMO property references in this query's FQL should be unqualified by a DMO alias name.
`logical`	`isOpen()` Conversion of IS-OPEN attribute (KW_IS_OPEN).
`boolean`	`isPresort()` Indicate whether the query is of presort type.
`protected boolean`	`isRepositionNotificationActive()` Indicate if we are currently notifying listeners of a reposition event.
`logical`	`isSkipDeletedRecord()` Get value of SKIP-DELETED-RECORD attribute of the query.
`boolean`	`isStandalone()` Indicate whether this query stands alone, or is wrapped by a query wrapper.
`protected void`	`loadRowAtCursor()` Synchronize the query with the cursor by causing the query to load the current row's results (if any) into its backing buffer(s).
`void`	`notifyQueryCloseListeners()` Notifies the registered QUERY-CLOSE listeners that the event is about to happen.
`void`	`notifyQueryOpenListeners(boolean evaluate)` Notifies the registered QUERY-OPEN listeners that the event is about to happen.
`void`	`notifyRepositionListeners(boolean closed, boolean error, int targetRepositionRow)` Notify all registered listeners that query is repositioned or closed.
`integer`	`numBuffers()` Conversion of NUM-BUFFERS() method (KW_NUM_BUFF).
`static integer`	`numResults(character queryName)` Implementation of NUM-RESULTS P4GL function.
`static integer`	`numResults(P2JQuery query)` Implementation of NUM-RESULTS P4GL function.
`void`	`open()` Reposition the prepared query to the first result if the query is being browsed.
`logical`	`prepare(character predicate)` Compiles a predicate (query condition).
`logical`	`prepare(java.lang.String predicate)` Compiles a predicate (query condition).
`protected boolean`	`prepareFetch()` Prepare to perform a fetch.
`character`	`prepareString()` Conversion of PREPARE_STRING attribute (KW_PREP_STR).
`protected static boolean`	`preprocessSubstitutionArguments(BufferManager bufMgr, java.util.function.Supplier<java.lang.Boolean> isFindByRowid, boolean suppressNestedQueryError, java.lang.Object[] args)` Iterate the array of query substitution parameters, if any, and resolve any which are instances of `P2JQuery.Parameter` in silent error mode.
`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).
`logical`	`queryRepositionByID(rowid id1, rowid... joinIDs)` Conversion of REPOSITION-TO-ROWID() method (KW_REPOS_2I).
`void`	`releaseBuffers()` Default, no-op implementation which should be overridden by subclasses which need to release the current record of each of their buffers in response to a fetch request while an error is pending in the error manager.
`void`	`removeRepositionListener(RepositionListener listener)` Unregister a listener that was receiving notifications on reposition events for this query.
`void`	`setBrowsed(boolean browsed)` Indicate to this query that whether it is associated with a browse widget or not.
`logical`	`setBuffers(Buffer... bufs)` Sets buffers for the query.
`logical`	`setBuffers(handle... hBuffers)` Sets buffers for the query.
`void`	`setCache(integer n)` Setter for the CACHE attribute.
`void`	`setCache(long n)` Setter for the CACHE attribute.
`void`	`setDataRelation(DataRelation relation)` Set the recursive DATA-RELATION the query is to FILL for.
`void`	`setDynamicPredicate(boolean dynamic)` Set this query in a 'dynamic' mode, to mark the fact that it was used as a dynamic delegate in a query resource.
`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.
`protected void`	`setFatalError()` Remember there was a fatal error during query substitution parameter processing and that this query should abort at the earliest appropriate time.
`void`	`setFetchOnReposition(boolean enable)` Set this query to automatically fetch the next record after a reposition, or turn this feature off.
`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()` This flag is used in order to allow reposition to unflushed records (ones which were not in the database when the query was opened).
`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.
`protected void`	`setOmitAlias(boolean omitAlias)` Specify whether DMO property references in this query's FQL should be unqualified by a DMO alias name.
`void`	`setOuter(boolean outer)` Sets the left-outer-join property for this query.
`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.
`boolean`	`silentCurrent()` Reload the record most recently loaded into the backing record buffer, if any.
`boolean`	`silentCurrent(LockType lockType)` Reload the record most recently loaded into the backing record buffer, if any.
`boolean`	`silentFirst()` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`silentFirst(LockType lockType)` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`silentLast()` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`silentLast(LockType lockType)` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`silentNext()` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`silentNext(LockType lockType)` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`silentPrevious()` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`silentPrevious(LockType lockType)` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`silentUnique()` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`silentUnique(LockType lockType)` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`protected static java.lang.String`	`translateSort(RecordBuffer[] bound, RecordBuffer[] definition, java.util.List<SortCriterion> defSort)` Translate this `sort` clause to use the bound DMOs' alias and property names, instead the definition (conversion-time) alias and property names.
`protected static java.lang.String`	`translateSort(RecordBuffer bound, RecordBuffer definition, java.lang.String sort)` Translate this `sort` clause to use the bound DMO's alias and property names, instead the definition (conversion-time) alias and property names.
`protected java.lang.String`	`translateWhere(java.util.List<RecordBuffer> bound, java.util.List<RecordBuffer> definition, java.lang.String where)` Translate this `where` clause to use the bound DMO's alias and property names, instead the definition (conversion-time) alias and property names.
`private logical`	`wrapCurrent(LockType lockType)` Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getCurrent() implementations
`private logical`	`wrapFirst(LockType lockType)` Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getFirst() implementations
`private logical`	`wrapLast(LockType lockType)` Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getLast() implementations
`private logical`	`wrapNext(LockType lockType)` Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getNext() implementations
`private logical`	`wrapPrevious(LockType lockType)` Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getPrevious() implementations

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.persist.P2JQuery
_isOffEnd, addDynamicFilter, backward, backward, clearDynamicFilters, clearResults, close, current, current, currentRow, currentRowImpl, first, first, forward, forward, getBasicLogging, getJoin, getNext, getOffEnd, getOffEndListeners, getRecordBuffers, getTableCount, hintFullResults, isFindByRowid, isFirstOfGroup, isFirstOfGroup, isLastOfGroup, isLastOfGroup, isNativelyPreselect, isPreselect, isScrolling, last, last, next, next, previous, previous, queryRepositionByID, reposition, reposition, repositionByID, repositionByID, repositionByID, resetQuery, setBasicLogging, setBasicLogging, size, unique, unique

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

- Field Detail
  - LOG
```
private static final CentralLogger LOG
```
    Logger
  - inverseSorting
```
protected boolean inverseSorting
```
    Indicates whether the query has the inverse sorting direction against the original sorting. E.g.,
```
  find next tt use-index si-name.
  find prev tt use-index si-name.
 
```
    will be converted to the code having a couple of AdaptiveFind queries:
```
  AdaptiveFind query1 = new AdaptiveFind(tt, null, "tt.name asc");
  AdaptiveFind query2 = new AdaptiveFind(tt, null, "tt.name desc", true);
 
```
    and the second query will have the inverse sorting direction.
  - closed
```
protected boolean closed
```
    Flag indicating if this query was explicitly closed.
  - parameterFilter
```
protected ParameterFilter parameterFilter
```
    The filter that handles parameters passed to the query.
  - dynamicPredicate
```
protected boolean dynamicPredicate
```
    Flag indicating this query is associated with a dynamically prepared query resource.
  - indexedReposition
```
protected boolean indexedReposition
```
    Flag to indicate if this query is optimized using indexed reposition
  - included
```
protected java.util.Map<DataModelObject,Property[]> included
```
    The included properties for each DMO (FIELDS option).
  - excluded
```
protected java.util.Map<DataModelObject,Property[]> excluded
```
    The excluded properties for each DMO (EXCEPT option).
  - fatalError
```
private boolean fatalError
```
    Flag indicating fatal error was encountered processing query substitution parameters
  - errorIfNull
```
private boolean errorIfNull
```
    Should the failed first/last/unique retrievals raise error?
  - lenientOffEnd
```
protected boolean lenientOffEnd
```
    false if running off end of results should raise error
  - outer
```
protected boolean outer
```
    Marks this as a left outer join component of the query.
  - errorHelper
```
protected ErrorManager.ErrorHelper errorHelper
```
    Context-local error helper used for silent mode operations.
  - standalone
```
private boolean standalone
```
    Does this query stand alone or is it contained by a query wrapper ?
  - fetchOnReposition
```
private boolean fetchOnReposition
```
    Should the next row be fetched after a reposition?
  - browsed
```
private boolean browsed
```
    Is query associated with a UI browse widget?
  - skipDeletedRecord
```
private boolean skipDeletedRecord
```
    Internal value of SKIP-DELETED-RECORD.
  - iterating
```
private boolean iterating
```
    Flag indicating whether the query is used inside a FOR EACH block.
  - presort
```
private boolean presort
```
    Flag indicating whether the BREAK BY statement is present
  - fillingBrowseRows
```
private boolean fillingBrowseRows
```
    This flags brackets the code which is invoked by browse widgets for populating its rows. When active, the deleted rows are not returned.
  - accumulators
```
private java.util.LinkedHashMap<Accumulator,java.lang.Boolean> accumulators
```
    Accumulators added to this query, mapped to their deferred status
  - repoRegistry
```
private WeakList<RepositionListener> repoRegistry
```
    Registry of listeners who are notified of query repositions
  - eventListeners
```
private java.util.List<P2JQuery.QueryEventListener> eventListeners
```
    Registry of listeners who are notified of query is about to (re-)open.
  - notificationActive
```
private boolean notificationActive
```
    Flag to avoid infinite recursion in reposition notification
  - externalBuffers
```
private RecordBuffer[] externalBuffers
```
    Set of external buffers, if any, referenced by this query
  - externalBuffersDefs
```
private RecordBuffer[] externalBuffersDefs
```
    Set of external buffer definitions, if any, referenced by this query
  - omitAlias
```
private boolean omitAlias
```
    Flag indicating that a DMO alias should not be used in this query's FQL statement
  - ignoreAfterRepo
```
private boolean ignoreAfterRepo
```
    Flag indicating if afterReposition(boolean) calls are skipped.
  - relation
```
private DataRelation relation
```
    The recursive DATA-RELATION the query is to FILL for
- Constructor Detail
  - AbstractQuery
```
protected AbstractQuery()
```
    Default constructor.
- Method Detail
  - numResults
```
public static integer numResults(character queryName)
```
    Implementation of NUM-RESULTS P4GL function.
    
    Parameters:
    
    queryName - A character expression that evaluates to the name of a currently open, scrolling query.
    
    Returns:
    
    the number of rows currently in the results list of a scrolling query. If queryName does not resolve to the name of a query, or if the query is not open or not scrolling, then the function returns the Unknown value (?).
  - numResults
```
public static integer numResults(P2JQuery query)
```
    Implementation of NUM-RESULTS P4GL function.
    
    Parameters:
    
    query - A character expression that evaluates to the name of a currently open, scrolling query.
    
    Returns:
    
    the number of rows currently in the results list of a scrolling query. If queryName does not resolve to the name of a query, or if the query is not open or not scrolling, then the function returns the Unknown value (?).
  - preprocessSubstitutionArguments
```
protected static boolean preprocessSubstitutionArguments(BufferManager bufMgr,
                                                         java.util.function.Supplier<java.lang.Boolean> isFindByRowid,
                                                         boolean suppressNestedQueryError,
                                                         java.lang.Object[] args)
```
    Iterate the array of query substitution parameters, if any, and resolve any which are instances of P2JQuery.Parameter in silent error mode. Those one which are instances of Resolvable are resolved in normal mode
    An important secondary purpose of this method is to check whether we are processing a query within the context of another query and raising an error condition if this is the case.
    If an error is encountered resolving a parameter, the method will abort and set all values in the args array to null. In this case, the method will return false instead of true, and it is up to the caller to handle the null arguments appropriately.
    This error handling behavior differs from the 4GL, in which an error may preempt processing some elements of the where clause, but continue evaluating others. This difference can become significant if the processing of certain parameters has side effects (for example, a user-defined function, which can do almost anything). This difference is a current limitation of the FWD runtime.
    
    Parameters:
    
    bufMgr - BufferManager instance for the current user context.
    
    isFindByRowid - A lambda expression which should return true if the current database operation represents a legacy FIND by RECID/ROWID, else false.
    
    suppressNestedQueryError - true to suppress (i.e., handle as a warning only, but do not alter control flow) a nested query error; false to allow such an error to alter control flow by permitting an ErrorConditionException thrown during nested query detection to propagate upward from this method.
    
    args - Array of query substitution arguments, or null if there are none.
    
    Returns:
    
    true if all arguments were resolved without error, false if any error occurred.
    
    Throws:
    
    ErrorConditionException - if a query is executed within the WHERE clause of another query and such an error is not suppressed.
  - translateSort
```
protected static java.lang.String translateSort(RecordBuffer bound,
                                                RecordBuffer definition,
                                                java.lang.String sort)
```
    Translate this sort clause to use the bound DMO's alias and property names, instead the definition (conversion-time) alias and property names.
    
    Parameters:
    
    bound - The runtime-bound buffer.
    
    definition - The buffer as it was used to generate the sort clause at conversion time.
    
    sort - The sort clause to be translated.
    
    Returns:
    
    The translated clause.
  - translateSort
```
protected static java.lang.String translateSort(RecordBuffer[] bound,
                                                RecordBuffer[] definition,
                                                java.util.List<SortCriterion> defSort)
```
    Translate this sort clause to use the bound DMOs' alias and property names, instead the definition (conversion-time) alias and property names.
    
    Parameters:
    
    bound - The runtime-bound buffers.
    
    definition - The buffers as it was used to generate the sort clause at conversion time.
    
    defSort - The sort clause to be translated as a list of SortCriterion.
    
    Returns:
    
    The translated clause.
  - translateWhere
```
protected java.lang.String translateWhere(java.util.List<RecordBuffer> bound,
                                          java.util.List<RecordBuffer> definition,
                                          java.lang.String where)
```
    Translate this where clause to use the bound DMO's alias and property names, instead the definition (conversion-time) alias and property names.
    
    Parameters:
    
    bound - The runtime-bound buffers.
    
    definition - The buffers as it was used to generate the where clause at conversion time.
    
    where - The HQL to be translated.
    
    Returns:
    
    The translated HQL.
  - buffersMatch
```
protected static boolean buffersMatch(RecordBuffer buf,
                                      RecordBuffer defBuf)
```
    Check if the two buffers differ.
    
    Parameters:
    
    buf - The first buffer.
    
    defBuf - The second buffer.
    
    Returns:
    
    true if the buffers are different instances or have different backing DMO interface.
  - fromLockNowait
```
private static LockType fromLockNowait(long lock,
                                       long nowait)
                                throws ErrorConditionException
```
    Return the LockType instance for the given internal lock and nowait with corresponding query processing.
    
    Parameters:
    
    lock - The lock type as an integer value (see lock type constants in LockType).
    
    nowait - The wait type as an integer value (see wait type constants in LockType).
    
    Returns:
    
    LockType instance.
    
    Throws:
    
    ErrorConditionException - If the operation fails.
  - setDynamicPredicate
```
public void setDynamicPredicate(boolean dynamic)
```
    Set this query in a 'dynamic' mode, to mark the fact that it was used as a dynamic delegate in a query resource.
    
    Specified by:
    
    setDynamicPredicate in interface P2JQuery
    
    Parameters:
    
    dynamic - Flag indicating that this is a dynamic delegate for a query resource.
  - isDynamicPredicate
```
public boolean isDynamicPredicate()
```
    Check if this query is originating from a dynamic predicate.
    
    Specified by:
    
    isDynamicPredicate in interface P2JQuery
    
    Returns:
    
    The dynamicPredicate value.
  - setScrolling
```
public void setScrolling()
```
    Enable results list scrolling/repositioning. This default implementation does nothing.
    
    Specified by:
    
    setScrolling in interface P2JQuery
  - setLenientOffEnd
```
public 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.
    
    Specified by:
    
    setLenientOffEnd in interface P2JQuery
    
    Parameters:
    
    lenientOffEnd - true to suppress QueryOffEndException for next and previous requests; false to permit these exceptions.
  - isLenientOffEnd
```
protected boolean isLenientOffEnd()
```
    Indicate whether this query will throw a QueryOffEndException when it runs off the end of its results.
    
    Returns:
    
    true if an exception will be thrown, else false.
  - setIndexedReposition
```
public void setIndexedReposition()
```
    This flag is used in order to allow reposition to unflushed records (ones which were not in the database when the query was opened). This can be set only when the query is scrolling. When a reposition to an unflushed record is made, the result list is reset. This method must be invoked before any results are retrieved.
    
    Specified by:
    
    setIndexedReposition in interface P2JQuery
  - isIndexedReposition
```
public boolean isIndexedReposition()
```
    Disable indexed reposition optimization to disallow repositioning to unflushed records. This method must be invoked before any results are retrieved.
    
    Specified by:
    
    isIndexedReposition in interface P2JQuery
    
    Returns:
    
    true if this query is indexed reposition.
  - open
```
public void open()
```
    Reposition the prepared query to the first result if the query is being browsed.
    
    Specified by:
    
    open in interface P2JQuery
  - isOffEnd
```
public 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.
    
    Specified by:
    
    isOffEnd in interface P2JQuery
    
    Returns:
    
    true if the cursor is off either end of its query's results list.
  - addAccumulator
```
public 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.
    
    Specified by:
    
    addAccumulator in interface P2JQuery
    
    Parameters:
    
    accum - Accumulator to be registered with this query.
  - addAccumulator
```
public 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.
    
    Specified by:
    
    addAccumulator in interface P2JQuery
    
    Parameters:
    
    accum - Accumulator to be registered with this query.
    
    deferred - If true, calls to accumulate() will not cause the accumulator to recalculate immediately, but instead to update the accumulator's state such that the next invocation of Accumulator.accumulate() will trigger the actual accumulation update. If false, the accumulator recalculates its internal state immediately.
  - isFetchOnReposition
```
public boolean isFetchOnReposition()
```
    Is this query set to fetch the next record after a reposition?
    
    Specified by:
    
    isFetchOnReposition in interface P2JQuery
    
    Returns:
    
    true if set to fetch after reposition, else false.
  - setFetchOnReposition
```
public void setFetchOnReposition(boolean enable)
```
    Set this query to automatically fetch the next record after a reposition, or turn this feature off.
    
    Specified by:
    
    setFetchOnReposition in interface P2JQuery
    
    Parameters:
    
    enable - true to enable automatic fetching; false to disable.
  - addQueryEventListener
```
public void addQueryEventListener(P2JQuery.QueryEventListener listener)
```
    Adds a listener to be notified when this query is open.
    Note that this method is only called for dynamic queries only (for the moment).
    
    Specified by:
    
    addQueryEventListener in interface P2JQuery
    
    Parameters:
    
    listener - The listener to be notified.
  - notifyQueryOpenListeners
```
public void notifyQueryOpenListeners(boolean evaluate)
```
    Notifies the registered QUERY-OPEN listeners that the event is about to happen.
    
    Specified by:
    
    notifyQueryOpenListeners in interface P2JQuery
    
    Parameters:
    
    evaluate - Flag indicating that the dynamic query must evaluate its dynamic calls (like DYNAMIC-FUNCTION) in the WHERE clause.
  - notifyQueryCloseListeners
```
public void notifyQueryCloseListeners()
```
    Notifies the registered QUERY-CLOSE listeners that the event is about to happen.
    
    Specified by:
    
    notifyQueryCloseListeners in interface P2JQuery
  - addRepositionListener
```
public void addRepositionListener(RepositionListener listener)
```
    Register a listener to receive notifications reposition events for this query.
    
    Specified by:
    
    addRepositionListener in interface P2JQuery
    
    Parameters:
    
    listener - Reposition listener to be registered.
  - removeRepositionListener
```
public void removeRepositionListener(RepositionListener listener)
```
    Unregister a listener that was receiving notifications on reposition events for this query.
    
    Specified by:
    
    removeRepositionListener in interface P2JQuery
    
    Parameters:
    
    listener - Reposition listener to be unregistered.
  - setBrowsed
```
public void setBrowsed(boolean browsed)
```
    Indicate to this query that whether it is associated with a browse widget or not.
    
    Specified by:
    
    setBrowsed in interface P2JQuery
    
    Parameters:
    
    browsed - true to indicate the query has an associated browse widget, else false.
  - setFillingBrowseRows
```
public 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.
    
    Specified by:
    
    setFillingBrowseRows in interface P2JQuery
    
    Parameters:
    
    on - if true the deleted rows will not be returned because the query is managed by the browse widget.
  - notifyRepositionListeners
```
public void notifyRepositionListeners(boolean closed,
                                      boolean error,
                                      int targetRepositionRow)
```
    Notify all registered listeners that query is repositioned or closed.
    
    Specified by:
    
    notifyRepositionListeners in interface P2JQuery
    
    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.
  - isStandalone
```
public boolean isStandalone()
```
    Indicate whether this query stands alone, or is wrapped by a query wrapper.
    
    Specified by:
    
    isStandalone in interface P2JQuery
    
    Returns:
    
    true if standalone, else false.
  - setStandalone
```
public 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 which contains it.
    
    Specified by:
    
    setStandalone in interface P2JQuery
    
    Parameters:
    
    standalone - true to set query as standalone; false to set query as contained.
  - cleanup
```
public void cleanup()
```
    Clean up resources associated with this query when its scope ends.
    This default implementation does nothing.
    
    Specified by:
    
    cleanup in interface P2JQuery
  - close
```
public void close()
```
    Explicitly close the prepared query.
    This default implementation calls cleanup().
    
    Specified by:
    
    close in interface P2JQuery
  - setOuter
```
public void setOuter(boolean outer)
```
    Sets the left-outer-join property for this query.
    
    Parameters:
    
    outer - true iif this is a left outer join component of the query.
  - isPresort
```
public boolean isPresort()
```
    Indicate whether the query is of presort type.
    
    Specified by:
    
    isPresort in interface P2JQuery
    
    Returns:
    
    true if the query is of presort type..
  - setPresort
```
public void setPresort(boolean presort)
```
    Indicate whether the query is of presort type.
    
    Specified by:
    
    setPresort in interface P2JQuery
    
    Parameters:
    
    presort - true indicating that a query of presort type. false is not of presort type.
  - setIterating
```
public void setIterating(boolean iterating)
```
    Indicate whether the query is defined inside the scope of FOR EACH block.
    
    Specified by:
    
    setIterating in interface P2JQuery
    
    Parameters:
    
    iterating - true indicating that a query is inside FOR EACH block; false is defined outside of a FOR EACH.
  - isIterating
```
public boolean isIterating()
```
    Indicate whether the query is defined inside the scope of FOR EACH block.
    
    Specified by:
    
    isIterating in interface P2JQuery
    
    Returns:
    
    true if the query was defined inside a FOR EACH block.
  - setErrorIfNull
```
public 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.
    
    Specified by:
    
    setErrorIfNull in interface P2JQuery
    
    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.
  - isBrowsed
```
public boolean isBrowsed()
```
    Report whether this query is associated with a browse widget.
    
    Specified by:
    
    isBrowsed in interface P2JQuery
    
    Returns:
    
    true if associated with a browse, else false.
  - addExternalBuffers
```
public 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 FQL expression, which are not the primary buffers associated with the query.
    
    Specified by:
    
    addExternalBuffers in interface P2JQuery
    
    Parameters:
    
    dmos - One or more external buffers.
    
    Returns:
    
    This query instance.
  - getReferencedBuffers
```
public RecordBuffer[] getReferencedBuffers()
```
    Get an array of all record buffers referenced by this query, including those directly involved in the query, as well as those (if any) indirectly referenced by inlined, converted, CAN-FIND expressions, and that which represents the inverse buffer of a natural join.
    
    Returns:
    
    All record buffers referenced by this query.
  - getErrorHelper
```
protected ErrorManager.ErrorHelper getErrorHelper()
```
    Retrieve the context-local error helper used for silent mode operations.
    
    Returns:
    
    The context-local error helper used for silent mode operations.
  - getDefaultLock
```
protected LockType getDefaultLock()
```
    Get the default lock type for this query.
    
    Returns:
    
    LockType.NONE if this is a dynamic delegate for a query resource, or LockType.SHARE otherwise.
  - getExternalBuffers
```
protected RecordBuffer[] getExternalBuffers()
```
    Get the external buffers, if any, associated with this query.
    
    Returns:
    
    Array of external buffers or null.
  - getExternalBuffersDefs
```
protected RecordBuffer[] getExternalBuffersDefs()
```
    Get the external buffers definitions, if any, associated with this query.
    
    Returns:
    
    Array of external buffers definitions or null.
  - isFatalError
```
protected boolean isFatalError()
```
    Indicate whether there was a fatal error during query substitution parameter processing which should abort this query at the earliest appropriate time.
    
    Returns:
    
    true if there was a query substitution parameter processing error, else false.
  - setFatalError
```
protected void setFatalError()
```
    Remember there was a fatal error during query substitution parameter processing and that this query should abort at the earliest appropriate time.
  - isErrorIfNull
```
protected boolean isErrorIfNull()
```
    Indicate whether failed FIRST, LAST, and UNIQUE retrieval attempts should be considered an error condition.
    
    Returns:
    
    true if failed first/last/unique retrievals should be considered an error; false is such failures should be considered a query off-end condition.
  - isOmitAlias
```
protected boolean isOmitAlias()
```
    Determine whether DMO property references in this query's FQL should be unqualified by a DMO alias name.
    
    Returns:
    
    true if the DMO alias should be omitted from property references, else false.
  - setOmitAlias
```
protected void setOmitAlias(boolean omitAlias)
```
    Specify whether DMO property references in this query's FQL should be unqualified by a DMO alias name.
    
    Parameters:
    
    omitAlias - true if the DMO alias should be omitted from property references, else false.
  - afterReposition
```
protected void afterReposition(boolean permitFetch)
```
    This method should be called by subclasses after any reposition of the query. If the query is set to fetch a record on reposition events, it does so now (using the P2JQuery.next() method). If any listeners are registered to receive notifications of reposition events, they are notified now.
    
    Parameters:
    
    permitFetch - true to permit immediate record fetch; false to override fetchOnReposition flag and explicitly disallow immediate record fetch.
  - afterReposition
```
protected void afterReposition(boolean permitFetch,
                               boolean error)
```
    This method should be called by subclasses after any reposition of the query. If the query is set to fetch a record on reposition events, it does so now (using the P2JQuery.next() method). If any listeners are registered to receive notifications of reposition events, they are notified now.
    
    Parameters:
    
    permitFetch - true to permit immediate record fetch; false to override fetchOnReposition flag and explicitly disallow immediate record fetch.
    
    error - true if error happened during reposition.
  - afterReposition
```
protected void afterReposition(boolean permitFetch,
                               integer oldCurrentRow)
```
    This method should be called by subclasses after any reposition of the query. If the query is set to fetch a record on reposition events, it does so now (using the P2JQuery.next() method). If any listeners are registered to receive notifications of reposition events, they are notified now.
    This method also brings the query to the required state if reposition has failed.
    
    Parameters:
    
    permitFetch - true to permit immediate record fetch; false to override fetchOnReposition flag and explicitly disallow immediate record fetch.
    
    oldCurrentRow - Current row at the start of the reposition. Can be unknown.
  - isRepositionNotificationActive
```
protected boolean isRepositionNotificationActive()
```
    Indicate if we are currently notifying listeners of a reposition event.
    
    Returns:
    
    true if a reposition notification is active, else false.
  - loadRowAtCursor
```
protected void loadRowAtCursor()
```
    Synchronize the query with the cursor by causing the query to load the current row's results (if any) into its backing buffer(s).
    This implementation does nothing; it should be overridden to implement this behavior as needed.
  - accumulate
```
protected final void accumulate()
```
    Notify accumulators attached to this query (if any) that a new result row has been accessed, and that they should update their internal state. Subclasses should invoke this method whenever an iteration of a query result occurs, such as on the retrieval of the first, last, next, or previous result row.
  - hasAccumulators
```
protected boolean hasAccumulators()
```
    Check if query has attached accumulators.
    
    Returns:
    
    true if accumulators attached to the query.
  - isNewBreakGroup
```
protected boolean isNewBreakGroup(Resolvable key)
```
    Subclasses which support the concept of break groups in query results should override this method to report whether the current result row being visited represents a new break group, for the given break group key.
    
    Parameters:
    
    key - Resolvable object which is used as the key to identify the break group category being tested.
    
    Returns:
    
    true if the current result represents the first entry in a new break group; else false. This default implementation always returns false.
  - isLastOfBreakGroup
```
protected boolean isLastOfBreakGroup(Resolvable key)
```
    Determine whether the query result row currently being visited is the last row within a break group whose category is identified by the specified resolvable object.
    
    Parameters:
    
    key - Break group category key. May be null (which should always trigger a false return).
    
    Returns:
    
    false; subclasses should override this method if a different result is required.
  - prepareFetch
```
protected boolean prepareFetch()
```
    Prepare to perform a fetch. This involves checking for a pending error in the error manager and releasing the current buffer record if an error is pending. Releasing the record may result in an exception being thrown by the record buffer.
    
    Returns:
    
    false if an error is pending, else true.
  - releaseBuffers
```
public void releaseBuffers()
```
    Default, no-op implementation which should be overridden by subclasses which need to release the current record of each of their buffers in response to a fetch request while an error is pending in the error manager.
    
    Specified by:
    
    releaseBuffers in interface P2JQuery
  - accumulate
```
private void accumulate(Accumulator accum,
                        boolean deferred)
```
    Invoke the appropriate iterate method variant on the specified accumulator. If the accumulator manages only a primary statistic (i.e., no break groups have been added), the simple form is invoked. If break groups have been added to the accumulator, the more complex form is invoked.
    
    Parameters:
    
    accum - Target accumulator object.
    
    deferred - true if the accumulator was registered to this query as a deferred accumulator, else false.
    
    See Also:
    
    addAccumulator(com.goldencode.p2j.util.Accumulator)
  - bufferHandle
```
public handle bufferHandle()
```
    Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH). Returns a handle of the first buffer of a query object.
    
    Specified by:
    
    bufferHandle in interface BufferCollection
    
    Returns:
    
    buffer handle
  - bufferHandle
```
public handle bufferHandle(java.lang.String bufferName)
```
    Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH). Returns a handle of a particular buffer of a query object.
    
    Specified by:
    
    bufferHandle in interface BufferCollection
    
    Parameters:
    
    bufferName - buffer-name. A CHARACTER expression that evaluates to the name of a buffer in the query or DataSet object.
    
    Returns:
    
    buffer handle
  - bufferHandle
```
public handle bufferHandle(character bufferName)
```
    Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH). Returns a handle of a particular buffer of a query object.
    
    Specified by:
    
    bufferHandle in interface BufferCollection
    
    Parameters:
    
    bufferName - buffer-name. A CHARACTER expression that evaluates to the name of a buffer in the query or DataSet object.
    
    Returns:
    
    buffer handle
  - bufferHandle
```
public handle bufferHandle(int bufferSequenceNumber)
```
    Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH). Returns a handle of a particular buffer of a query object.
    
    Specified by:
    
    bufferHandle in interface BufferCollection
    
    Parameters:
    
    bufferSequenceNumber - buffer-sequence-number. An INTEGER that represents the sequence number of the desired buffer.
    
    Returns:
    
    buffer handle
  - bufferHandle
```
public handle bufferHandle(int64 bufferSequenceNumber)
```
    Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH). Returns a handle of a particular buffer of a query object.
    
    Specified by:
    
    bufferHandle in interface BufferCollection
    
    Parameters:
    
    bufferSequenceNumber - buffer-sequence-number. An INTEGER that represents the sequence number of the desired buffer.
    
    Returns:
    
    buffer handle
  - queryClose
```
public logical queryClose()
```
    Conversion of QUERY-CLOSE() method (KW_QRY_CLOS). Closes a query object.
    
    Specified by:
    
    queryClose in interface P2JQuery
    
    Returns:
    
    true if QUERY-CLOSE() succeeds, else false.
  - queryBackward
```
public 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.
    
    Specified by:
    
    queryBackward in interface P2JQuery
    
    Returns:
    
    true if REPOSITION-BACKWARD() succeeds, else false.
  - queryBackward
```
public 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.
    
    Specified by:
    
    queryBackward in interface P2JQuery
    
    Returns:
    
    true if REPOSITION-BACKWARD() succeeds, else false.
  - queryForward
```
public 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.
    
    Specified by:
    
    queryForward in interface P2JQuery
    
    Returns:
    
    true if REPOSITION-FORWARD() succeeds, else false.
  - queryForward
```
public 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.
    
    Specified by:
    
    queryForward in interface P2JQuery
    
    Returns:
    
    true if REPOSITION-FORWARD() succeeds, else false.
  - queryReposition
```
public 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.
    
    Specified by:
    
    queryReposition in interface P2JQuery
    
    Parameters:
    
    n - An integer expression representing the sequence number.
    
    Returns:
    
    true if REPOSITION-TO-ROW() succeeds, else false.
  - queryReposition
```
public 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.
    
    Specified by:
    
    queryReposition in interface P2JQuery
    
    Parameters:
    
    n - An integer expression representing the sequence number.
    
    Returns:
    
    true if REPOSITION-TO-ROW() succeeds, else false.
  - queryRepositionByID
```
public 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.
    
    Specified by:
    
    queryRepositionByID in interface P2JQuery
    
    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.
  - getNumResults
```
public integer getNumResults()
```
    Conversion of NUM-RESULTS attribute (KW_NUM_RES). Getter of NUM-RESULTS attribute
    
    Specified by:
    
    getNumResults in interface P2JQuery
  - addBuffer
```
public logical addBuffer(handle bufHandle)
```
    Adds one new buffer to a query object or dynamic DataSet object, without affecting the other buffers, if any. Use the SET-BUFFERS( ) method to remove all prior buffers and set all buffers for the object at the same time.
    
    Specified by:
    
    addBuffer in interface BufferCollection
    
    Parameters:
    
    bufHandle - A buffer handle to add.
    
    Returns:
    
    true on success
  - addBuffer
```
public logical addBuffer(Buffer buf)
```
    Adds one new buffer to a query object or dynamic DataSet object, without affecting the other buffers, if any. Use the SET-BUFFERS( ) method to remove all prior buffers and set all buffers for the object at the same time.
    
    Specified by:
    
    addBuffer in interface BufferCollection
    
    Parameters:
    
    buf - A buffer to add.
    
    Returns:
    
    true on success
  - setBuffers
```
public logical setBuffers(handle... hBuffers)
```
    Sets buffers for the query. Any buffers previously added or set are removed. Use the addBuffer() method to add one buffer to the object, without affecting the other buffers, if any. This method is the equivalent of SET-BUFFERS() method from 4GL.
    
    Specified by:
    
    setBuffers in interface BufferCollection
    
    Parameters:
    
    hBuffers - Variable argument list of buffer handles to be set. In 4GL, the maximum number of buffers per query is 18.
    
    Returns:
    
    true on success
  - setBuffers
```
public logical setBuffers(Buffer... bufs)
```
    Sets buffers for the query. Any buffers previously added or set are removed. Use the addBuffer() method to add one buffer to the object, without affecting the other buffers, if any. This method is the equivalent of SET-BUFFERS() method from 4GL.
    
    Specified by:
    
    setBuffers in interface BufferCollection
    
    Parameters:
    
    bufs - Variable argument list of Buffer to be set. In 4GL, the maximum number of buffers per query is 18.
    
    Returns:
    
    true on success
  - prepare
```
public logical prepare(java.lang.String predicate)
```
    Compiles a predicate (query condition). The query must be open after this call. This method is the equivalent of QUERY-PREPARE() method from 4GL.
    
    Specified by:
    
    prepare in interface P2JQuery
    
    Parameters:
    
    predicate - The predicate to be prepared by this query. The syntax of the string is the same of the OPEN QUERY statement of the 4GL.
    
    Returns:
    
    true on success
  - prepare
```
public logical prepare(character predicate)
```
    Compiles a predicate (query condition). The query must be open after this call. This method is the equivalent of QUERY-PREPARE() method from 4GL.
    
    Specified by:
    
    prepare in interface P2JQuery
    
    Parameters:
    
    predicate - The predicate to be prepared by this query. The syntax of the string is the same of the OPEN QUERY statement of the 4GL.
    
    Returns:
    
    true on success
  - queryOpen
```
public 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.
    
    Specified by:
    
    queryOpen in interface P2JQuery
    
    Returns:
    
    true on success
  - indexInformation
```
public character indexInformation()
```
    Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO). Getter of INDEX-INFORMATION attribute
    
    Specified by:
    
    indexInformation in interface IndexInformation
    
    Specified by:
    
    indexInformation in interface P2JQuery
    
    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
```
public character indexInformation(int n)
```
    Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO). Getter of INDEX-INFORMATION attribute
    
    Specified by:
    
    indexInformation in interface IndexInformation
    
    Specified by:
    
    indexInformation in interface P2JQuery
    
    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
```
public character indexInformation(NumberType n)
```
    Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO). Getter of INDEX-INFORMATION attribute
    
    Specified by:
    
    indexInformation in interface IndexInformation
    
    Specified by:
    
    indexInformation in interface P2JQuery
    
    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
```
public logical forwardOnly()
```
    Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY). Getter of FORWARD-ONLY attribute.
    
    Specified by:
    
    forwardOnly in interface P2JQuery
    
    Returns:
    
    current value of FORWARD-ONLY attribute.
  - changeForwardOnly
```
public void changeForwardOnly(logical forwardOnly)
```
    Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY). Setter of FORWARD-ONLY attribute.
    
    Specified by:
    
    changeForwardOnly in interface P2JQuery
    
    Parameters:
    
    forwardOnly - New value of FORWARD-ONLY attribute.
  - changeForwardOnly
```
public void changeForwardOnly(boolean forwardOnly)
```
    Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY). Setter of FORWARD-ONLY attribute.
    
    Specified by:
    
    changeForwardOnly in interface P2JQuery
    
    Parameters:
    
    forwardOnly - New value of FORWARD-ONLY attribute.
  - prepareString
```
public character prepareString()
```
    Conversion of PREPARE_STRING attribute (KW_PREP_STR). Getter of PREPARE_STRING attribute.
    
    Specified by:
    
    prepareString in interface P2JQuery
    
    Returns:
    
    current value of PREPARE_STRING attribute.
  - getCache
```
public integer getCache()
```
    Getter for the CACHE attribute.
    
    Specified by:
    
    getCache in interface P2JQuery
    
    Returns:
    
    See above.
  - setCache
```
public void setCache(integer n)
```
    Setter for the CACHE attribute.
    
    Specified by:
    
    setCache in interface P2JQuery
    
    Parameters:
    
    n - The cache value.
  - setCache
```
public void setCache(long n)
```
    Setter for the CACHE attribute.
    
    Specified by:
    
    setCache in interface P2JQuery
    
    Parameters:
    
    n - The cache value.
  - isOpen
```
public logical isOpen()
```
    Conversion of IS-OPEN attribute (KW_IS_OPEN). Getter of IS-OPEN attribute.
    
    Specified by:
    
    isOpen in interface Openable
    
    Returns:
    
    current value of IS-OPEN attribute.
  - _getNext
```
public 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.
    
    Specified by:
    
    _getNext in interface P2JQuery
    
    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
```
public logical getNext(LockType lockType)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Specified by:
    
    getNext in interface P2JQuery
    
    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
```
public logical getNext(long lock)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Specified by:
    
    getNext in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getNext
```
public logical getNext(NumberType lock)
```
    Conversion of GET-NEXT method (KW_GET_NEXT). Moves a query object's result list pointer ahead one row.
    
    Specified by:
    
    getNext in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getNext
```
public 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.
    
    Specified by:
    
    getNext in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getNext
```
public 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.
    
    Specified by:
    
    getNext in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getNext
```
public 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.
    
    Specified by:
    
    getNext in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getNext
```
public 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.
    
    Specified by:
    
    getNext in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getPrevious
```
public logical getPrevious()
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Specified by:
    
    getPrevious in interface P2JQuery
    
    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
```
public logical getPrevious(long lock)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Specified by:
    
    getPrevious in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getPrevious
```
public logical getPrevious(LockType lockType)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Specified by:
    
    getPrevious in interface P2JQuery
    
    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
```
public logical getPrevious(NumberType lock)
```
    Conversion of GET-PREV method (KW_GET_PREV). Moves a query object's result list pointer back one row.
    
    Specified by:
    
    getPrevious in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getPrevious
```
public 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.
    
    Specified by:
    
    getPrevious in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getPrevious
```
public 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.
    
    Specified by:
    
    getPrevious in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getPrevious
```
public 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.
    
    Specified by:
    
    getPrevious in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getPrevious
```
public 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.
    
    Specified by:
    
    getPrevious in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getFirst
```
public logical getFirst()
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Specified by:
    
    getFirst in interface P2JQuery
    
    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
```
public logical getFirst(long lock)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Specified by:
    
    getFirst in interface P2JQuery
    
    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.
    
    ErrorConditionException - If the operation fails.
  - getFirst
```
public logical getFirst(NumberType lock)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Specified by:
    
    getFirst in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getFirst
```
public logical getFirst(LockType lockType)
```
    Conversion of GET-FIRST method (KW_GET_1ST). Moves a query object's result list pointer to the first row.
    
    Specified by:
    
    getFirst in interface P2JQuery
    
    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
```
public 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.
    
    Specified by:
    
    getFirst in interface P2JQuery
    
    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.
    
    ErrorConditionException - If the operation fails.
  - getFirst
```
public 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.
    
    Specified by:
    
    getFirst in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getFirst
```
public 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.
    
    Specified by:
    
    getFirst in interface P2JQuery
    
    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.
    
    ErrorConditionException - If the operation fails.
  - getFirst
```
public 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.
    
    Specified by:
    
    getFirst in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getLast
```
public logical getLast()
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Specified by:
    
    getLast in interface P2JQuery
    
    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
```
public logical getLast(long lock)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Specified by:
    
    getLast in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getLast
```
public logical getLast(NumberType lock)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Specified by:
    
    getLast in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getLast
```
public logical getLast(LockType lockType)
```
    Conversion of GET-LAST method (KW_GET_LAST). Moves a query object's result list pointer to the last row.
    
    Specified by:
    
    getLast in interface P2JQuery
    
    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
```
public 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.
    
    Specified by:
    
    getLast in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getLast
```
public 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.
    
    Specified by:
    
    getLast in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getLast
```
public 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.
    
    Specified by:
    
    getLast in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getLast
```
public 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.
    
    Specified by:
    
    getLast in interface P2JQuery
    
    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:
    
    ErrorConditionException - If the operation fails.
  - getCurrent
```
public logical getCurrent()
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Re-fetches the current record or records associated with the query.
    
    Specified by:
    
    getCurrent in interface P2JQuery
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - getCurrent
```
public logical getCurrent(long lock)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Re-fetches the current record or records associated with the query.
    
    Specified by:
    
    getCurrent in interface P2JQuery
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
    
    Throws:
    
    ErrorConditionException - If the operation fails.
  - getCurrent
```
public logical getCurrent(NumberType lock)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Re-fetches the current record or records associated with the query.
    
    Specified by:
    
    getCurrent in interface P2JQuery
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
    
    Throws:
    
    ErrorConditionException - If the operation fails.
  - getCurrent
```
public logical getCurrent(LockType lockType)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Re-fetches the current record or records associated with the query.
    
    Specified by:
    
    getCurrent in interface P2JQuery
    
    Parameters:
    
    lockType - of LockType
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - getCurrent
```
public logical getCurrent(long lock,
                          long nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Re-fetches the current record or records associated with the query.
    
    Specified by:
    
    getCurrent in interface P2JQuery
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
    
    Throws:
    
    ErrorConditionException - If the operation fails.
  - getCurrent
```
public logical getCurrent(NumberType lock,
                          long nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Re-fetches the current record or records associated with the query.
    
    Specified by:
    
    getCurrent in interface P2JQuery
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
    
    Throws:
    
    ErrorConditionException - If the operation fails.
  - getCurrent
```
public logical getCurrent(long lock,
                          NumberType nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Re-fetches the current record or records associated with the query.
    
    Specified by:
    
    getCurrent in interface P2JQuery
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
    
    Throws:
    
    ErrorConditionException - If the operation fails.
  - getCurrent
```
public logical getCurrent(NumberType lock,
                          NumberType nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Re-fetches the current record or records associated with the query.
    
    Specified by:
    
    getCurrent in interface P2JQuery
    
    Parameters:
    
    lock - SHARE-LOCK|EXCLUSIVE-LOCK|NO-LOCK
    
    nowait - NO-WAIT
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
    
    Throws:
    
    ErrorConditionException - If the operation fails.
  - hasAny
```
public 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.
    
    Specified by:
    
    hasAny in interface P2JQuery
    
    Returns:
    
    true if the first record exists, else false.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Always, this method must be implemented in derived classes.
  - hasAny
```
public 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.
    
    Specified by:
    
    hasAny in interface P2JQuery
    
    Parameters:
    
    values - Query substitution parameters.
    
    Returns:
    
    true if the first record exists, else false.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Always, this method must be implemented in derived classes.
  - hasAny
```
public 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.
    
    Specified by:
    
    hasAny in interface P2JQuery
    
    Parameters:
    
    lockType - The lock type for the query. This lock is not actually acquired, only tested for availability.
    
    Returns:
    
    true if the first record exists, else false.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Always, this method must be implemented in derived classes.
  - hasAny
```
public 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.
    
    Specified by:
    
    hasAny in interface P2JQuery
    
    Parameters:
    
    values - Query substitution parameters.
    
    lockType - The lock type for the query. This lock is not actually acquired, only tested for availability.
    
    Returns:
    
    true if the first record exists, else false.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Always, this method must be implemented in derived classes.
  - hasOne
```
public 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.
    
    Specified by:
    
    hasOne in interface P2JQuery
    
    Returns:
    
    true if any record matching the query's criteria exists, else false.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Always, this method must be implemented in derived classes.
  - hasOne
```
public 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.
    
    Specified by:
    
    hasOne in interface P2JQuery
    
    Parameters:
    
    values - Query substitution parameters.
    
    Returns:
    
    true if any record matching the query's criteria exists, else false.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Always, this method must be implemented in derived classes.
  - hasOne
```
public 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.
    
    Specified by:
    
    hasOne in interface P2JQuery
    
    Parameters:
    
    lockType - The 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.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Always, this method must be implemented in derived classes.
  - hasOne
```
public 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.
    
    Specified by:
    
    hasOne in interface P2JQuery
    
    Parameters:
    
    values - Query substitution parameters.
    
    lockType - The 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.
    
    Throws:
    
    java.lang.UnsupportedOperationException - Always, this method must be implemented in derived classes.
  - silentFirst
```
public boolean silentFirst()
```
    Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentFirst(Object[])
    - RandomAccessQuery.silentFirst(Object[], LockType)
    Returns:
    
    true if query could retrieve the first record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode.
    
    QueryOffEndException - if no record could be found when operating in compound query mode.
  - silentFirst
```
public boolean silentFirst(LockType lockType)
```
    Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentFirst(Object[])
    - RandomAccessQuery.silentFirst(Object[], LockType)
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode.
    
    QueryOffEndException - if no record could be found when operating in compound query mode.
  - silentLast
```
public boolean silentLast()
```
    Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentLast(Object[])
    - RandomAccessQuery.silentLast(Object[], LockType)
    Returns:
    
    true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode.
    
    QueryOffEndException - if no record could be found when operating in compound query mode.
  - silentLast
```
public boolean silentLast(LockType lockType)
```
    Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentLast(Object[])
    - RandomAccessQuery.silentLast(Object[], LockType)
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrieve the last record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval or if no record could be found when operating in standalone mode.
    
    QueryOffEndException - if no record could be found when operating in compound query mode.
  - silentNext
```
public boolean silentNext()
```
    Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
    Use the record most recently loaded into the backing buffer as the reference point when determining the next record to visit. If no record has yet been loaded into the buffer, retrieve the first record which meets the query criteria.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentNext(Object[])
    - RandomAccessQuery.silentNext(Object[], LockType)
    Returns:
    
    true if query could retrieve the next record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
    
    QueryOffEndException - if no record could be found.
  - silentNext
```
public boolean silentNext(LockType lockType)
```
    Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
    Use the record most recently loaded into the backing buffer as the reference point when determining the next record to visit. If no record has yet been loaded into the buffer, retrieve the first record which meets the query criteria.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentNext(Object[])
    - RandomAccessQuery.silentNext(Object[], LockType)
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrieve the next record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
    
    QueryOffEndException - if no record could be found.
  - silentPrevious
```
public boolean silentPrevious()
```
    Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
    Use the record most recently loaded into the backing buffer as the reference point when determining the previous record to visit. If no record has yet been loaded into the buffer, retrieve the last record which meets the query criteria.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentPrevious(Object[])
    - RandomAccessQuery.silentPrevious(Object[], LockType)
    Returns:
    
    true if query could retrieve the previous record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
    
    QueryOffEndException - if no record could be found.
  - silentPrevious
```
public boolean silentPrevious(LockType lockType)
```
    Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
    Use the record most recently loaded into the backing buffer as the reference point when determining the previous record to visit. If no record has yet been loaded into the buffer, retrieve the last record which meets the query criteria.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentPrevious(Object[])
    - RandomAccessQuery.silentPrevious(Object[], LockType)
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrieve the previous record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
    
    QueryOffEndException - if no record could be found.
  - silentUnique
```
public boolean silentUnique()
```
    Navigate to a particular record which meets the query criteria and retrieve it into its record buffer. No more than one record may match the criteria.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentUnique(Object[])
    - RandomAccessQuery.silentUnique(Object[], LockType)
    Returns:
    
    true if query could retrieve the unique record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval or if more than one record is found which match the criteria.
    
    QueryOffEndException - if no record could be found when operating in compound query mode.
  - silentUnique
```
public boolean silentUnique(LockType lockType)
```
    Navigate to a particular record which meets the query criteria and retrieve it into its record buffer. No more than one record may match the criteria.
    This operation is executed in silent mode.
    Additional methods are defined for specific queries such as:
    - RandomAccessQuery.silentUnique(Object[])
    - RandomAccessQuery.silentUnique(Object[], LockType)
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrieve the unique record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval or if more than one record is found which match the criteria.
    
    QueryOffEndException - if no record could be found when operating in compound query mode.
  - silentCurrent
```
public boolean silentCurrent()
```
    Reload the record most recently loaded into the backing record buffer, if any.
    This operation is executed in silent mode.
    
    Returns:
    
    true if query could retrieve the current record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record reload.
  - silentCurrent
```
public boolean silentCurrent(LockType lockType)
```
    Reload the record most recently loaded into the backing record buffer, if any.
    This operation is executed in silent mode.
    
    Parameters:
    
    lockType - New lock type to apply to the record.
    
    Returns:
    
    true if query could retrieve the current record successfully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record reload.
  - include
```
public void include(DataModelObject dmo,
                    java.lang.String... fields)
```
    Specifies the fields included in a record retrieval.
    
    Specified by:
    
    include in interface P2JQuery
    
    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
```
public void exclude(DataModelObject dmo,
                    java.lang.String... fields)
```
    Specifies the fields excluded from a record retrieval.
    
    Specified by:
    
    exclude in interface P2JQuery
    
    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.
  - numBuffers
```
public integer numBuffers()
```
    Conversion of NUM-BUFFERS() method (KW_NUM_BUFF).
    
    Specified by:
    
    numBuffers in interface BufferCollection
    
    Returns:
    
    the number of buffers in a query or DataSet object.
  - deleteResultListEntry
```
public logical deleteResultListEntry()
```
    Deletes the current row of a query's result list. Implements the 4GL DELETE-RESULT-LIST-ENTRY() method.
    
    Specified by:
    
    deleteResultListEntry in interface P2JQuery
    
    Returns:
    
    true on success.
  - deleteResultListEntry
```
public logical deleteResultListEntry(boolean allowBetweenRows)
```
    Deletes the current row of a query's result list. Implements the 4GL DELETE-RESULT-LIST-ENTRY() method.
    
    Specified by:
    
    deleteResultListEntry in interface P2JQuery
    
    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:
    
    always throws IllegalStateException.
  - createResultListEntry
```
public 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).
    
    Specified by:
    
    createResultListEntry in interface P2JQuery
    
    Returns:
    
    true on success.
  - setSkipDeletedRecord
```
public void setSkipDeletedRecord(logical on)
```
    Setter for SKIP-DELETED-RECORD query attribute.
    
    Specified by:
    
    setSkipDeletedRecord in interface P2JQuery
    
    Parameters:
    
    on - New value for the attribute.
  - isSkipDeletedRecord
```
public logical isSkipDeletedRecord()
```
    Get value of SKIP-DELETED-RECORD attribute of the query.
    
    Specified by:
    
    isSkipDeletedRecord in interface P2JQuery
    
    Returns:
    
    the value of SKIP-DELETED-RECORD attribute of the query.
  - setParameterFilter
```
public 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.
    
    Specified by:
    
    setParameterFilter in interface P2JQuery
    
    Parameters:
    
    parameterFilter - The filter that handles passed parameters.
  - isFillingBrowseRows
```
public boolean isFillingBrowseRows()
```
    Test whether the flag was set.
    
    Specified by:
    
    isFillingBrowseRows in interface P2JQuery
    
    Returns:
    
    true during the returning of rows for populating a browse widget.
    
    See Also:
    
    setFillingBrowseRows(boolean)
  - _isSkipDeletedRecord
```
boolean _isSkipDeletedRecord()
```
    Test whether the SKIP-DELETED-RECORD attribute is set.
    
    Returns:
    
    the value of SKIP-DELETED-RECORD attribute of the query as a Java boolean.
  - wrapNext
```
private logical wrapNext(LockType lockType)
```
    Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getNext() implementations
    
    Parameters:
    
    lockType - instance of LockType
    
    Returns:
    
    true if GET-NEXT() succeeds, else false.
  - wrapPrevious
```
private logical wrapPrevious(LockType lockType)
```
    Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getPrevious() implementations
    
    Parameters:
    
    lockType - instance of LockType
    
    Returns:
    
    true if GET-PREV() succeeds, else false.
  - wrapFirst
```
private logical wrapFirst(LockType lockType)
```
    Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getFirst() implementations
    
    Parameters:
    
    lockType - instance of LockType
    
    Returns:
    
    true if GET-FIRST() succeeds, else false.
  - wrapLast
```
private logical wrapLast(LockType lockType)
```
    Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getLast() implementations
    
    Parameters:
    
    lockType - instance of LockType
    
    Returns:
    
    true if GET-LAST() succeeds, else false.
  - wrapCurrent
```
private logical wrapCurrent(LockType lockType)
```
    Worker method for wrapping ErrorConditionException and reusing in all P2JQuery.getCurrent() implementations
    
    Parameters:
    
    lockType - instance of LockType
    
    Returns:
    
    true if GET-CURRENT() succeeds, else false.
  - collectFields
```
private void collectFields(java.util.Map<DataModelObject,Property[]> target,
                           DataModelObject dmo,
                           java.lang.String[] fields,
                           RecordBuffer buffer)
```
    Populate the map of with the ORM properties specified in the given fields.
    
    Parameters:
    
    target - The target map.
    
    dmo - The DMO instance.
    
    fields - The fields to resolve.
    
    buffer - The buffer instance.
  - getDataRelation
```
public DataRelation getDataRelation()
```
    Get the recursive DATA-RELATION the query is to FILL for.
    
    Specified by:
    
    getDataRelation in interface P2JQuery
    
    Returns:
    
    the recursive DATA-RELATION the query is to FILL for
  - setDataRelation
```
public void setDataRelation(DataRelation relation)
```
    Set the recursive DATA-RELATION the query is to FILL for.
    
    Specified by:
    
    setDataRelation in interface P2JQuery
    
    Parameters:
    
    relation - the relation in question

Class AbstractQuery

Nested Class Summary

Nested classes/interfaces inherited from interface com.goldencode.p2j.persist.P2JQuery

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

LOG

inverseSorting

closed

parameterFilter

dynamicPredicate

indexedReposition

included

excluded

fatalError

errorIfNull

lenientOffEnd

outer

errorHelper

standalone

fetchOnReposition

browsed

skipDeletedRecord

iterating

presort

fillingBrowseRows

accumulators

repoRegistry

eventListeners

notificationActive

externalBuffers

externalBuffersDefs

omitAlias

ignoreAfterRepo

relation

Constructor Detail

AbstractQuery

Method Detail

numResults

numResults

preprocessSubstitutionArguments

translateSort

translateSort

translateWhere

buffersMatch

fromLockNowait

setDynamicPredicate

isDynamicPredicate

setScrolling

setLenientOffEnd

isLenientOffEnd

setIndexedReposition

isIndexedReposition

open

isOffEnd

addAccumulator

addAccumulator

isFetchOnReposition

setFetchOnReposition

addQueryEventListener

notifyQueryOpenListeners

notifyQueryCloseListeners

addRepositionListener

removeRepositionListener

setBrowsed

setFillingBrowseRows

notifyRepositionListeners

isStandalone

setStandalone

cleanup

close

setOuter

isPresort

setPresort

setIterating

isIterating