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

java.lang.Object
- com.goldencode.p2j.util.HandleResource
- - com.goldencode.p2j.util.HandleChain
  - - com.goldencode.p2j.persist.QueryWrapper

All Implemented Interfaces:

BufferCollection, IndexInformation, P2JQuery, ResultListHandler, ADMData, CallbackProcedure, CommonHandle, CommonHandleChain, Deletable, DynamicResource, InstantiatingProcedure, Nameable, Openable, UniqueID, WrappedResource, Printable
```
public final class QueryWrapper
extends HandleChain
implements P2JQuery, ADMData, UniqueID, DynamicResource, ResultListHandler, CallbackProcedure
```
A delegating container implementation for AbstractQuerys. An instance of this class contains an instance of AbstractQuery, to which it delegates the work of all of its methods.
The purpose of this class is to support queries defined in Progress using the DEFINE QUERY statement. These may be defined once, but opened and closed multiple times. In the P2J implementation, a new instance of AbstractQuery is constructed each time a query is "opened" (i.e., an OPEN QUERY was issued in the pre-conversion code). Since a reference to the query may be held by many routines, the query's internal state must be updated when the query is opened or re-opened. This is accomplished by sharing a reference to an instance of this class, which always holds the most recently constructed, underlying query. Thus, since all routines are accessing the query via this container (i.e., essentially by proxy), they will always be accessing the correct, underlying query. When a new query is opened, the new AbstractQuery instance is stored in the wrapper via one of the assign method variants.
The public methods of this class may only be invoked if the underlying delegate query is of a type which implements a method of the same signature. Many methods are supported by AbstractQuery, which is the abstract base class of all concrete query implementations. However, certain methods are implemented only by particular implementations. These will fail with an IllegalStateException if invoked when the wrong type of delegate has been set.
When an instance of this class is first created, a no-op, default implementation of P2JQuery is assigned immediately. This ensures that at least those methods which are defined by the P2JQuery interface have a safe methods. However, this does not protect the caller from invoking methods which are unique to specific query types, if no safe delegate has first been assigned. This safety measure is intended to protect other runtime code which generically uses an instance of this class via the P2JQuery interface (such as BrowseWidge in the UI).
A query wrapped by this object may need to clean up resources when the wrapper goes out of scope. A cleaner object is registered with the transaction manager upon construction of the wrapper, at the next external scope. This scope assumes that a QueryWrapper is only instantiated as an instance member of a business logic class. This is the case for all converted Progress code.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`QueryWrapper.DefaultDelegate` A no-op implementation of `P2JQuery` which is used as the default delegate for the enclosing `QueryWrapper`.

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.lang.String`	`admData` Corresponds ADM-DATA attribute.
`private boolean`	`advanced` Flag indicating if the query has been advanced (via GET NEXT) to the next record.
`private boolean`	`browsed` Is query associated with a UI browse widget?
`private java.util.ArrayList<Buffer>`	`buffers` The set of buffers used by this dynamic query.
`private CallbackData`	`callback` The only possible callback.
`private boolean`	`cleanerRegistered` If the cleaner is already registered as a finalizable for this wrapper.
`private boolean`	`closed` Flag indicating if the query was explicitly closed or is not open.
`private static P2JQuery`	`DEFAULT_DELEGATE` Default delegate to use before a real one is assigned
`private P2JQuery`	`delegate` Delegate query
`private boolean`	`dynamic` Flag indicating if this query is dynamic.
`private boolean`	`dynamicDelegate` Flag indicating if the query's `delegate` is dynamic.
`private boolean`	`errorIfNull` Should delegate's failed first/last/unique retrievals raise error?
`private boolean`	`explicit` Flags this query as an explicit query to allow the programmer to delete it.
`private ResultListHandler`	`externalResultListHandler` External handler for create/delete result list entry methods.
`private boolean`	`fetchOnReposition` Should the next row of the delegate be fetched after a reposition?
`private boolean`	`forwardOnly` Corresponds FORWARD-ONLY attribute.
`private boolean`	`indexedReposition` Should delegate be optimized using indexed reposition
`private static CentralLogger`	`LOG` Logger
`private static InvokeConfig`	`OFF_END_CALL_SITE` The call-site for the `OFF_END_EVENT` event callback.
`private static java.lang.String`	`OFF_END_EVENT` The `OFF-END` event string constant in upper case.
`private boolean`	`offEnd` Current off-end state.
`private java.util.ArrayList<P2JQuery.QueryOpenedListener>`	`openedListeners` Opened listeners registered to get the message about query has been opened.
`private java.lang.String`	`prepareString` Contains the prepare string set by `prepare(java.lang.String)`.
`private java.lang.String`	`qname` Internal reference for the query's name.
`private DataRelation`	`relation` The recursive DATA-RELATION the query is to FILL for
`private WeakList<RepositionListener>`	`repoListeners` Reposition listeners registered with the delegate query
`private boolean`	`scrolling` Should delegate be a scrolling query?
`private boolean`	`skipDeletedRecordDisposition` The initial disposition for the value of SKIP-DELETED-RECORD.
`private java.util.List<Buffer>`	`substBuffers` The list of substitution buffers.
`private java.lang.Long`	`uniqueID` Corresponds UNIQUE-ID attribute.
`private boolean`	`valid` Check if this query is valid.
`private java.util.Set<QueryWrapperListener>`	`wrapperListeners` Query wrapper listeners.

Fields inherited from class com.goldencode.p2j.util.HandleChain
name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource
instProc, pm

Constructor Summary

Constructors
Modifier	Constructor and Description
	`QueryWrapper(java.lang.String name, boolean scrolling)` Deprecated. This method was kept only to make the code already compiled against previous revision of FWD work. Although the code is unchanged the runtime will attempt to use of this signature as chosen by linker instead of `QueryWrapper(String, boolean, String...)`.
`private`	`QueryWrapper(java.lang.String name, boolean scrolling, boolean dynamic)` Constructor which sets query scrolling mode for all delegate queries assigned to this wrapper.
	`QueryWrapper(java.lang.String name, boolean scrolling, java.lang.String... browseNames)` Constructor which creates a static query and sets query scrolling mode for all delegate queries assigned to this wrapper.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`_dynamic()` Conversion of DYNAMIC attribute.
`boolean`	`_getNext()` Conversion of GET-NEXT method (KW_GET_NEXT), which returns a Java boolean, for internal usage.
`boolean`	`_isOffEnd()` Indicate whether the cursor has run off one or the other end of the associated query's list of available results.
`void`	`addAccumulator(Accumulator accum)` Add an accumulator to this query.
`void`	`addAccumulator(Accumulator accum, boolean deferred)` Add an accumulator to this query.
`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(Buffer buf, boolean staticCall)` Adds one new buffer to a query object or dynamic DataSet object, without affecting the other buffers, if any.
`logical`	`addBuffer(character bufName)` 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.
`logical`	`addBuffer(java.lang.String bufName)` Adds one new buffer to a query object or dynamic DataSet object, without affecting the other buffers, if any.
`private void`	`addBuffers(Joinable query, boolean clear)` Add the buffers associated with the given query to this QUERY's buffer list.
`void`	`addComponent(DataModelObject dmo, java.lang.String where)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, DataModelObject inverse)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, DataModelObject inverse, LockType lockType)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, DataModelObject inverse, java.lang.Object[] args)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, DataModelObject inverse, java.lang.Object[] args, LockType lockType)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, DataModelObject inverse, java.lang.Object[] args, LockType lockType, int iteration, boolean outer)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, LockType lockType)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.Object[] args)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.Object[] args, LockType lockType)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.Object[] args, LockType lockType, int iteration, boolean outer)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo, DataModelObject inverse)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo, DataModelObject inverse, LockType lockType)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo, DataModelObject inverse, java.lang.Object[] args)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo, DataModelObject inverse, java.lang.Object[] args, LockType lockType)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo, DataModelObject inverse, java.lang.Object[] args, LockType lockType, int iteration, boolean outer)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo, LockType lockType)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo, java.lang.Object[] args)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo, java.lang.Object[] args, LockType lockType)` Add a component to a preselect query.
`void`	`addComponent(DataModelObject dmo, java.lang.String where, java.lang.String indexInfo, java.lang.Object[] args, LockType lockType, int iteration, boolean outer)` Add a component to a preselect query.
`void`	`addComponent(Joinable query)` Add a joinable query to a compound query.
`void`	`addComponent(Joinable query, int iteration)` Add a joinable query to a compound query, and specify the nature of the iteration which will be performed (first, last, next, etc.) on that component, when the compound query is iterated.
`void`	`addComponent(Joinable query, int iteration, boolean outer)` Add a joinable query to a compound query, and specify the nature of the iteration which will be performed (first, last, next, etc.) on that component, when the compound query is iterated.
`boolean`	`addDynamicFilter(FieldReference fr, BaseDataType val, java.lang.String format)` Adds a new constraint term to the where predicate of this query, effectively filtering out any rows whose referenced field does not match the requested value.
`void`	`addDynamicSort(FieldReference[] fieldReferences, boolean[] asc)` Adds new sorting criteria as the most coarse set of criteria for sorting the result of this query.
`void`	`addDynamicSort(FieldReference fr, boolean asc)` Adds a new sorting criterion as the strongest criterion for sorting the result of this query.
`P2JQuery`	`addExternalBuffers(DataModelObject... dmos)` Add one or more buffers to the list of those which this query references externally.
`void`	`addOpenedListener(P2JQuery.QueryOpenedListener listener)` Register a listener to receive notifications about the query has been opened.
`void`	`addQueryEventListener(P2JQuery.QueryEventListener listener)` Adds a listener to be notified when this query is opened or closed.
`void`	`addQueryWrapperListener(QueryWrapperListener listener)` Adds a listener to be notified about the query wrapper events.
`void`	`addRepositionListener(RepositionListener listener)` Register a listener to receive notifications reposition events for this query.
`void`	`addSortCriterion(Resolvable sort)` Add a single sort criterion, in the form of a `Resolvable` object which is resolved at sort time.
`void`	`addSortCriterion(Resolvable sort, boolean descending)` Add a single sort criterion, in the form of a `Resolvable` object which is resolved at runtime.
`void`	`addWhereExpression(java.util.function.Supplier<logical> whereExpr)` Add a client-side where expression to a preselect query.
`boolean`	`allowDelete(handle ref, boolean explicit)` Check if the resource can veto the delete or not, before attempting the `HandleChain.delete()` call.
`logical`	`applyCallback(java.lang.String eventName)` Applies a callback procedure, which allows execution of a defined event without duplicating the event procedure definition.
`handle`	`asHandle()` Generate a handle to the query object.
`void`	`assign(CompoundQuery delegate)` Assign a newly opened `CompoundQuery` instance as this container's active delegate query.
`void`	`assign(PreselectQuery delegate)` Assign a newly opened `PreselectQuery` instance as this container's active delegate query.
`void`	`assign(RandomAccessQuery delegate)` Assign a newly opened `RandomAccessQuery` instance as this container's active delegate query.
`private void`	`assignImpl(P2JQuery delegate)` Assign a `P2JQuery` instance as this container's active delegate query.
`private void`	`assignImpl(P2JQuery delegate, boolean open)` Assign a `P2JQuery` instance as this container's active delegate query.
`boolean`	`backward(int rows)` Move the current cursor position backward by the specified number of rows.
`boolean`	`backward(NumberType rows)` Move the current cursor position backward by the specified number of rows.
`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).
`Buffer`	`bufferHandleNative()` Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH).
`private boolean`	`canAddBuffer()` Check if a buffer can be added to this query.
`private boolean`	`canGet()` Check if the query is opened.
`private boolean`	`canGetFirst()` Check if the query can be advanced via GET-FIRST.
`private boolean`	`canGetStmt()` Check if the query is opened.
`private boolean`	`canLastOrPrev()` Check if the GET-LAST or GET-FIRST can be executed.
`private boolean`	`canReposition()` Check if the query is opened.
`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()` Delegate cleanup processing to the query wrapped by this object.
`void`	`clearDynamicFilters()` Clears any dynamically filters added at runtime.
`void`	`clearDynamicSorts()` Clears any dynamically sort criteria added at runtime.
`void`	`clearResults()` Clear the current results from the query, so the same query instance can be executed again, without having to `re-open` it.
`void`	`close()` Explicitly close the prepared query delegate.
`private CompoundQuery`	`compoundDelegate()` Convenience method to access the delegate query as an instance of `CompoundQuery`.
`static void`	`createQuery(handle hQuery)` Dynamically creates a query and assign it to a handle.
`static void`	`createQuery(handle hQuery, character widgetPool)` Dynamically creates a query in the specified widget pool and assign it to a handle.
`static void`	`createQuery(handle hQuery, java.lang.String widgetPool)` Dynamically creates a query in the specified widget pool and assign it to a handle.
`static QueryWrapper`	`createQueryUnnamedPool()` Dynamically creates a query in the specified widget pool.
`logical`	`createResultListEntry()` Creates an entry in the result list for the current row.
`logical`	`createResultListEntryWorker()` Calls delegate's `P2JQuery.createResultListEntry()`.
`boolean`	`current()` Reload the record most recently loaded into the backing record buffer, if any.
`boolean`	`current(LockType lockType)` Reload the record most recently loaded into the backing record buffer, if any.
`integer`	`currentRow()` Progress-compatible function that returns the 1-based index of the current row in the result set.
`integer`	`currentRowImpl()` Get the 1-based index of the current row in the result set.
`logical`	`deleteResultListEntry()` Deletes the current row of a query's result list.
`logical`	`deleteResultListEntry(boolean allowBetweenRows)` Deletes the current row of a query's result list.
`logical`	`deleteResultListEntryWorker()` Calls delegate's `P2JQuery.deleteResultListEntry()`.
`logical`	`dynamic()` Conversion of DYNAMIC attribute.
`void`	`enableBreakGroups()` Enable all sort criteria set for this query to act as break group categories.
`void`	`exclude(DataModelObject dmo, java.lang.String... fields)` Specifies the fields excluded from a record retrieval.
`boolean`	`first()` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`first(boolean iterating)` Retrieve the first virtual, composite row of results for a compound query.
`boolean`	`first(boolean iterating, LockType lockType)` Retrieve the first virtual, composite row of results for a compound query, overriding the lock type to apply to each underlying query.
`boolean`	`first(LockType lockType)` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`first(java.lang.Object[] values)` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`first(java.lang.Object[] values, LockType lockType)` Navigate to the first record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`forward(int rows)` Advance the current cursor position forward by the specified number of rows.
`boolean`	`forward(NumberType rows)` Advance the current cursor position forward by the specified number of rows.
`logical`	`forwardOnly()` Conversion of FORWARD-ONLY attribute (KW_FWD_ONLY).
`character`	`getADMData()` Get the value of the ADM-DATA attribute.
`Buffer`	`getBufferByIndex(int bufferSequenceNumber)` Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH).
`integer`	`getCache()` Getter for the CACHE attribute.
`handle`	`getCallbackProcContext(java.lang.String eventName)` Retrieves the handle of the procedure that contains the internal procedure associated with the ABL callback for the specified event
`character`	`getCallbackProcName(java.lang.String eventName)` Retrieves the name of the internal procedure associated with the ABL callback for the specified event.
`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.
`private DataSet`	`getDataSet()` Obtains the `Dataset` of the first buffer of this query, if this is defined.
`private P2JQuery`	`getDelegate()` Convenience method to access the current delegate 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).
`java.lang.String`	`getName()` Get legacy query name.
`logical`	`getNext(LockType lockType)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(long lock)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(long lock, long nowait)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(long lock, NumberType nowait)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(NumberType lock)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(NumberType lock, long nowait)` Conversion of GET-NEXT method (KW_GET_NEXT).
`logical`	`getNext(NumberType lock, NumberType nowait)` Conversion of GET-NEXT method (KW_GET_NEXT).
`integer`	`getNumResults()` Conversion of NUM-RESULTS attribute (KW_NUM_RES).
`OffEnd`	`getOffEnd()` Get the off-end status of the query, which indicates whether the query has run off either end of its results.
`java.util.ArrayList<QueryOffEndListener>`	`getOffEndListeners()` Get all the off-end listeners associated with this query.
`logical`	`getPrevious()` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(LockType lockType)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(long lock)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(long lock, long nowait)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(long lock, NumberType nowait)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(NumberType lock)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(NumberType lock, long nowait)` Conversion of GET-PREV method (KW_GET_PREV).
`logical`	`getPrevious(NumberType lock, NumberType nowait)` Conversion of GET-PREV method (KW_GET_PREV).
`RecordBuffer[]`	`getRecordBuffers()` Get a list of all buffers in this query.
`int`	`getTableCount()` Get the number of tables joined by this query.
`integer`	`getUniqueID()` Gets the the unique ID number associated to this object by the underlying system.
`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`	`hintFullResults()` Mark the query to retrieve the entire result set (useful for FILL operations).
`void`	`include(DataModelObject dmo, java.lang.String... fields)` Specifies the fields included in a record retrieval.
`character`	`indexInformation()` Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO).
`character`	`indexInformation(int n)` Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO).
`character`	`indexInformation(NumberType n)` Conversion of INDEX-INFORMATION attribute (KW_IDX_INFO).
`protected boolean`	`invokeCallback(handle self, CallbackData cbd)` Invokes a callback procedure or a callback method.
`boolean`	`isBrowsed()` Is this query associated with a browse widget or not?
`private static boolean`	`isCallbackName(java.lang.String someName)` Test whether a string is a valid CALLBACK name for a `DataSet Query`.
`(package private) boolean`	`isExplicit()` Test whether this is an explicit query.
`boolean`	`isFetchOnReposition()` Is this query set to fetch the next record after a reposition?
`boolean`	`isFillingBrowseRows()` Checks whether 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`).
`logical`	`isFirst()` Determine whether the query result row currently being visited is the first row in the presorted results list.
`logical`	`isFirstOfGroup(int level)` Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
`logical`	`isFirstOfGroup(integer level)` Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
`logical`	`isFirstOfGroup(Resolvable key)` Determine whether the query result row currently being visited is the first row within a break group whose category is identified by the specified resolvable object.
`boolean`	`isIndexedReposition()` Indicate whether this query is optimized using indexed reposition.
`boolean`	`isIterating()` Indicate whether the delegate query is defined inside the scope of FOR EACH block.
`logical`	`isLast()` Determine whether the query result row currently being visited is the last row in the presorted results list.
`logical`	`isLastOfGroup(int level)` Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
`logical`	`isLastOfGroup(integer level)` Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
`logical`	`isLastOfGroup(Resolvable key)` Determine whether the query result row currently being visited is the first row within a break group whose category is identified by the specified resolvable object.
`boolean`	`isNativelyPreselect()` Indicate whether this query is a preselect query by its nature.
`logical`	`isOffEnd()` Indicate whether the cursor has run off one or the other end of the associated query's list of available results.
`logical`	`isOpen()` Conversion of IS-OPEN attribute (KW_IS_OPEN).
`boolean`	`isPreselect()` Indicate whether this query preselects all of its results.
`boolean`	`isPresort()` Indicate whether the delegate query is of presort type.
`boolean`	`isScrolling()` Indicate whether this query was defined as SCROLLING.
`logical`	`isSkipDeletedRecord()` Get value of SKIP-DELETED-RECORD attribute of the query.
`boolean`	`isStandalone()` Indicate whether this query stands alone, or is the component of another query, or is wrapped by a query wrapper.
`void`	`iterate()` Advance a compound query, triggering one or more of the underlying queries to retrieve a new record.
`boolean`	`last()` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`void`	`last(boolean iterating)` Retrieve the last virtual, composite row of results for a compound query.
`void`	`last(boolean iterating, LockType lockType)` Retrieve the last virtual, composite row of results for a compound query, overriding the lock type to apply to each underlying query.
`boolean`	`last(LockType lockType)` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`void`	`last(java.lang.Object[] values)` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`void`	`last(java.lang.Object[] values, LockType lockType)` Navigate to the last record which meets the query criteria and retrieve it into its record buffer.
`private void`	`maybeFireCallback()` Test whether the OFF-END event occurred and if so, fire the callback if one is defined.
`boolean`	`next()` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`next(boolean iterating)` Retrieve the next virtual, composite row of results for a compound query.
`boolean`	`next(boolean iterating, LockType lockType)` Retrieve the next virtual, composite row of results for a compound query, overriding the lock type to apply to each underlying query.
`boolean`	`next(LockType lockType)` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`next(java.lang.Object[] values)` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`next(java.lang.Object[] values, LockType lockType)` Navigate to the next record which meets the query criteria and retrieve it into its record buffer.
`(package private) void`	`notifyBeforeOpenListeners()` Notify query wrapper event listeners that the query is about to be opened.
`void`	`notifyListeners()` Deprecated. Use #open() instead.
`protected void`	`notifyQueryDeleted()` Notify all registered listeners the query is deleted.
`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).
`void`	`open()` Open the prepared query delegate.
`private Buffer`	`parseBuffer(BufferManager bm, java.lang.String bufName, int bufIdx)` Identify the buffer which matches the given buffer name.
`logical`	`prepare(character predicate)` Compiles a predicate (query condition).
`logical`	`prepare(java.lang.String predicate)` Compiles a predicate (query condition).
`character`	`prepareString()` Conversion of PREPARE_STRING attribute (KW_PREP_STR).
`private PreselectQuery`	`preselectDelegate()` Convenience method to access the delegate query as an instance of `PreselectQuery`.
`private PresortDelegate`	`presortDelegate()` Convenience method to access the delegate query as an instance of `PresortDelegate`.
`boolean`	`previous()` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`previous(boolean iterating)` Retrieve the previous virtual, composite row of results for a compound query.
`boolean`	`previous(boolean iterating, LockType lockType)` Retrieve the previous virtual, composite row of results for a compound query, overriding the lock type to apply to each underlying query.
`boolean`	`previous(LockType lockType)` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`previous(java.lang.Object[] values)` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`previous(java.lang.Object[] values, LockType lockType)` Navigate to the previous record which meets the query criteria and retrieve it into its record buffer.
`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(character rowId)` Conversion of REPOSITION-TO-ROWID() method (KW_REPOS_2I).
`logical`	`queryRepositionByID(rowid id1, rowid... joinIDs)` Conversion of REPOSITION-TO-ROWID() method (KW_REPOS_2I).
`private RandomAccessQuery`	`randomAccessDelegate()` Convenience method to access the delegate query as an instance of `RandomAccessQuery`.
`private void`	`registerCleaner()` Register the cleaner which closes the query when the external [persistent] procedure in which the query was opened is deleted.
`void`	`releaseBuffers()` Release the buffers.
`void`	`removeOpenedListener(P2JQuery.QueryOpenedListener listener)` De-register a listener to receive notifications about the query has been opened.
`void`	`removeQueryWrapperListener(QueryWrapperListener listener)` Remove a listener from being notified about the query wrapper events.
`void`	`removeRepositionListener(RepositionListener listener)` Unregister a listener that was receiving notifications on reposition events for this query.
`void`	`reposition(int row)` Reposition the query to the specified row in the result set.
`void`	`reposition(NumberType row)` Reposition the cursor to the specified row in the result set.
`boolean`	`repositionByID(java.lang.Long... joinIDs)` Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs.
`void`	`repositionByID(recid id)` Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified primary key ID.
`void`	`repositionByID(rowid id1, rowid... joinIDs)` Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs.
`void`	`resetQuery()` Reset the query (this does not close the query).
`protected boolean`	`resourceDelete()` Delete the resource.
`void`	`setADMData(character value)` Set the value of the ADM-DATA attribute.
`void`	`setADMData(java.lang.String value)` Set the value of the ADM-DATA attribute.
`void`	`setBrowsed(boolean browsed)` Indicate to this query that whether it is associated with a browse widget or not.
`void`	`setBrowsed(ResultListHandler resultListHandler)` Sets an external result list handler and marks the query as browsed.
`logical`	`setBuffers(Buffer... bufs)` Sets buffers for the query.
`logical`	`setBuffers(handle... hBuffers)` Sets buffers for the query.
`logical`	`setBuffers(java.lang.Object... bufs)` Sets buffers for the query.
`void`	`setCache(integer n)` Setter for the CACHE attribute.
`void`	`setCache(long n)` Setter for the CACHE attribute.
`logical`	`setCallback(java.lang.String callbackName, java.lang.String routineName, object<?> context)` Configures a callback.
`logical`	`setCallbackProcedure(java.lang.String eventName, java.lang.String callback, handle context)` Associates an internal procedure with an ABL callback event.
`void`	`setDataRelation(DataRelation relation)` Set the recursive DATA-RELATION the query is to FILL for.
`private void`	`setDelegateIndexedReposition()` Helper for making delegate query indexed reposition while checking the eligibility.
`void`	`setErrorIfNull(boolean errorIfNull)` Set a mode on the underlying buffers such that setting a null record into a buffer may or may not result in an error condition.
`void`	`setFetchOnReposition(boolean enable)` Set this query to automatically fetch the next record after a reposition, or turn this feature off.
`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`).
`(package private) void`	`setImplicit()` Mark this query as implicit.
`void`	`setIndexedReposition()` Ensure that any `AbstractQuery` assigned to this wrapper is a optimized query using indexed reposition.
`void`	`setIterating(boolean iterating)` Indicate whether the query is defined inside the scope of FOR EACH block.
`void`	`setIterationType(int iteration)` Set the iteration type for the most recently added query component to a preselect query.
`void`	`setIterationType(int iteration, java.lang.String sort)` Set the iteration type for the most recently added query component to a preselect query.
`void`	`setLenientOffEnd(boolean lenientOffEnd)` Set the behavior of this query as a record retrieval request moves off the end of its results.
`void`	`setParameterFilter(ParameterFilter parameterFilter)` Set the filter that handles parameters passed to the query.
`void`	`setPresort(boolean presort)` Indicate whether the delegate query is of presort type.
`void`	`setScrolling()` Ensure that any `AbstractQuery` assigned to this wrapper is a scrolling query, to 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.
`(package private) void`	`setSubstitutionBuffers(Buffer... substs)` Instruct dynamic conversion to add a list of substitution buffers.
`(package private) void`	`setSubstitutionBuffers(Buffer datasetBuffer)` Instruct dynamic conversion to use the list of 'parent' buffers of `datasetBuffer` as substitution buffers.
`integer`	`size()` Get the *current* size of the cached results list.
`boolean`	`unique()` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`unique(LockType lockType)` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`unique(java.lang.Object[] values)` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`boolean`	`unique(java.lang.Object[] values, LockType lockType)` Navigate to a particular record which meets the query criteria and retrieve it into its record buffer.
`private void`	`unregisterBufferRelatedQueries()` Unregister this wrapper from the list of related queries for all participating buffers.
`boolean`	`valid()` Reports if this query (that is, its delegate query) is valid for use.
`private boolean`	`validBuffer(handle h, int idx)` Check if the resource referenced by given handle is a valid `Buffer`.

Methods inherited from class com.goldencode.p2j.util.HandleChain
_name, delete, firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNameReadOnly, hasNextSibling, hasParent, hasPrevSibling, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, name, readOnlyError, readOnlyError, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource
_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown

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

Methods inherited from interface com.goldencode.p2j.persist.P2JQuery
close, getBasicLogging, getJoin, getNext, isDynamicPredicate, isFindByRowid, notifyQueryCloseListeners, notifyQueryOpenListeners, setBasicLogging, setBasicLogging, setDynamicPredicate

Methods inherited from interface com.goldencode.p2j.util.CallbackProcedure
applyCallback, getCallbackProcContext, getCallbackProcName, setCallback, setCallback, setCallback, setCallback, setCallback, setCallback, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure, setCallbackProcedure

Methods inherited from interface com.goldencode.p2j.util.CommonHandle
resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource
id, id, unknown

Methods inherited from interface com.goldencode.util.Printable
asString, print

- Field Detail
  - LOG
```
private static final CentralLogger LOG
```
    Logger
  - DEFAULT_DELEGATE
```
private static final P2JQuery DEFAULT_DELEGATE
```
    Default delegate to use before a real one is assigned
  - OFF_END_EVENT
```
private static final java.lang.String OFF_END_EVENT
```
    The OFF-END event string constant in upper case.
    
    See Also:
    
    Constant Field Values
  - OFF_END_CALL_SITE
```
private static final InvokeConfig OFF_END_CALL_SITE
```
    The call-site for the OFF_END_EVENT event callback.
  - delegate
```
private P2JQuery delegate
```
    Delegate query
  - repoListeners
```
private final WeakList<RepositionListener> repoListeners
```
    Reposition listeners registered with the delegate query
  - scrolling
```
private boolean scrolling
```
    Should delegate be a scrolling query?
  - indexedReposition
```
private boolean indexedReposition
```
    Should delegate be optimized using indexed reposition
  - errorIfNull
```
private boolean errorIfNull
```
    Should delegate's failed first/last/unique retrievals raise error?
  - fetchOnReposition
```
private boolean fetchOnReposition
```
    Should the next row of the delegate be fetched after a reposition?
  - browsed
```
private boolean browsed
```
    Is query associated with a UI browse widget?
  - openedListeners
```
private final java.util.ArrayList<P2JQuery.QueryOpenedListener> openedListeners
```
    Opened listeners registered to get the message about query has been opened.
  - wrapperListeners
```
private java.util.Set<QueryWrapperListener> wrapperListeners
```
    Query wrapper listeners.
  - closed
```
private boolean closed
```
    Flag indicating if the query was explicitly closed or is not open.
  - offEnd
```
private boolean offEnd
```
    Current off-end state. Used to detect when off-end state was encountered and fire OFF-END callback.
  - advanced
```
private boolean advanced
```
    Flag indicating if the query has been advanced (via GET NEXT) to the next record.
  - dynamic
```
private boolean dynamic
```
    Flag indicating if this query is dynamic.
  - dynamicDelegate
```
private boolean dynamicDelegate
```
    Flag indicating if the query's delegate is dynamic. This can be true even for a static query resource.
  - admData
```
private java.lang.String admData
```
    Corresponds ADM-DATA attribute.
  - uniqueID
```
private java.lang.Long uniqueID
```
    Corresponds UNIQUE-ID attribute.
  - forwardOnly
```
private boolean forwardOnly
```
    Corresponds FORWARD-ONLY attribute.
  - prepareString
```
private java.lang.String prepareString
```
    Contains the prepare string set by prepare(java.lang.String).
  - buffers
```
private final java.util.ArrayList<Buffer> buffers
```
    The set of buffers used by this dynamic query.
  - valid
```
private boolean valid
```
    Check if this query is valid.
  - qname
```
private final java.lang.String qname
```
    Internal reference for the query's name.
  - cleanerRegistered
```
private boolean cleanerRegistered
```
    If the cleaner is already registered as a finalizable for this wrapper.
  - skipDeletedRecordDisposition
```
private boolean skipDeletedRecordDisposition
```
    The initial disposition for the value of SKIP-DELETED-RECORD. It is true for normal queries and false for static browsed queries.
  - substBuffers
```
private java.util.List<Buffer> substBuffers
```
    The list of substitution buffers. These are not the main buffers the query is iterating but may appear in SUBST nodes (as substitution). By default (when null), each buffer in a dynamic query must appear exactly one time in FOR clause.
  - externalResultListHandler
```
private ResultListHandler externalResultListHandler
```
    External handler for create/delete result list entry methods.
  - callback
```
private CallbackData callback
```
    The only possible callback. null if not set.
  - relation
```
private DataRelation relation
```
    The recursive DATA-RELATION the query is to FILL for
  - explicit
```
private boolean explicit
```
    Flags this query as an explicit query to allow the programmer to delete it. When a query is created implicitly, the programmer will not be able to delete it (err 12349), but the deletion of the object is performed automatically.
- Constructor Detail
  - QueryWrapper
```
@Deprecated
public QueryWrapper(java.lang.String name,
                                boolean scrolling)
```
    Deprecated. This method was kept only to make the code already compiled against previous revision of FWD work. Although the code is unchanged the runtime will attempt to use of this signature as chosen by linker instead of QueryWrapper(String, boolean, String...).
    
    Constructor which creates a static query and sets query scrolling mode for all delegate queries assigned to this wrapper.
    
    Parameters:
    
    name - The legacy name of this query.
    
    scrolling - true to set all delegate queries assigned to this wrapper to scrolling mode, else false to not use scrolling mode.
  - QueryWrapper
```
public QueryWrapper(java.lang.String name,
                    boolean scrolling,
                    java.lang.String... browseNames)
```
    Constructor which creates a static query and sets query scrolling mode for all delegate queries assigned to this wrapper.
    
    Parameters:
    
    name - The legacy name of this query.
    
    scrolling - true to set all delegate queries assigned to this wrapper to scrolling mode, else false to not use scrolling mode.
    
    browseNames - The legacy name of any BROWSEs widgets which use this query.
  - QueryWrapper
```
private QueryWrapper(java.lang.String name,
                     boolean scrolling,
                     boolean dynamic)
```
    Constructor which sets query scrolling mode for all delegate queries assigned to this wrapper.
    
    Parameters:
    
    name - The legacy name of this query.
    
    scrolling - true to set all delegate queries assigned to this wrapper to scrolling mode, else false to not use scrolling mode.
    
    dynamic - Flag identifying a dynamic query.
- Method Detail
  - clearResults
```
public void clearResults()
```
    Clear the current results from the query, so the same query instance can be executed again, without having to re-open it.
    
    Specified by:
    
    clearResults in interface P2JQuery
  - hintFullResults
```
public void hintFullResults()
```
    Mark the query to retrieve the entire result set (useful for FILL operations).
    
    Specified by:
    
    hintFullResults in interface P2JQuery
  - registerCleaner
```
private void registerCleaner()
```
    Register the cleaner which closes the query when the external [persistent] procedure in which the query was opened is deleted.
  - createQuery
```
public static void createQuery(handle hQuery,
                               java.lang.String widgetPool)
```
    Dynamically creates a query in the specified widget pool and assign it to a handle. This method is the equivalent of CREATE QUERY from 4GL.
    
    Parameters:
    
    hQuery - The handle to assign the newly created query.
    
    widgetPool - The name of the widget pool that contains the dynamic query. null if the unnamed pool must be used.
  - createQuery
```
public static void createQuery(handle hQuery,
                               character widgetPool)
```
    Dynamically creates a query in the specified widget pool and assign it to a handle. This method is the equivalent of CREATE QUERY from 4GL.
    
    Parameters:
    
    hQuery - The handle to assign the newly created query.
    
    widgetPool - The name of the widget pool that contains the dynamic query. null if the unnamed pool must be used.
  - createQuery
```
public static void createQuery(handle hQuery)
```
    Dynamically creates a query and assign it to a handle. This form of the method will create the object in the current default widget pool. This method is the equivalent of CREATE QUERY from 4GL.
    
    Parameters:
    
    hQuery - The handle to assign the newly created query.
  - createQueryUnnamedPool
```
public static QueryWrapper createQueryUnnamedPool()
```
    Dynamically creates a query in the specified widget pool. This method is the equivalent of CREATE QUERY from 4GL.
    
    Returns:
    
    the newly created query.
  - dynamic
```
public logical dynamic()
```
    Conversion of DYNAMIC attribute. Returns true if the buffer is dynamic.
    
    Specified by:
    
    dynamic in interface DynamicResource
    
    Returns:
    
    true if the resource is dynamic, false otherwise.
  - _dynamic
```
public boolean _dynamic()
```
    Conversion of DYNAMIC attribute. Returns true if the buffer is dynamic.
    
    Specified by:
    
    _dynamic in interface DynamicResource
    
    Returns:
    
    true if the resource is dynamic, false otherwise.
  - assign
```
public void assign(CompoundQuery delegate)
```
    Assign a newly opened CompoundQuery instance as this container's active delegate query.
    
    Parameters:
    
    delegate - New delegate query.
  - assign
```
public void assign(PreselectQuery delegate)
```
    Assign a newly opened PreselectQuery instance as this container's active delegate query.
    
    Parameters:
    
    delegate - New delegate query.
  - assign
```
public void assign(RandomAccessQuery delegate)
```
    Assign a newly opened RandomAccessQuery instance as this container's active delegate query.
    
    Parameters:
    
    delegate - New delegate query.
  - setScrolling
```
public void setScrolling()
```
    Ensure that any AbstractQuery assigned to this wrapper is a scrolling query, to enable results list scrolling/repositioning. If a query is already assigned to this wrapper, invoke its setScrolling method immediately.
    
    Specified by:
    
    setScrolling in interface P2JQuery
  - isScrolling
```
public boolean isScrolling()
```
    Indicate whether this query was defined as SCROLLING.
    
    Specified by:
    
    isScrolling in interface P2JQuery
    
    Returns:
    
    true if this query is scrolling.
  - 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 delegate 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.
  - isPresort
```
public boolean isPresort()
```
    Indicate whether the delegate 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 delegate 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.
  - setIndexedReposition
```
public void setIndexedReposition()
```
    Ensure that any AbstractQuery assigned to this wrapper is a optimized query using indexed reposition. This flag can be set only if the query is scrolling. An indexed reposition query can be repositioned to an unflushed record (one which was not in the database when the query was opened). Repositioning to such record will empty the result list.
    
    Specified by:
    
    setIndexedReposition in interface P2JQuery
    
    Throws:
    
    ErrorConditionException - if the underlying delegate is not scrolling.
  - isIndexedReposition
```
public boolean isIndexedReposition()
```
    Indicate whether this query is optimized using indexed reposition.
    
    Specified by:
    
    isIndexedReposition in interface P2JQuery
    
    Returns:
    
    true if this query is indexed reposition.
  - open
```
public void open()
```
    Open the prepared query delegate.
    
    Specified by:
    
    open in interface P2JQuery
  - close
```
public void close()
```
    Explicitly close the prepared query delegate.
    
    Specified by:
    
    close in interface P2JQuery
  - resetQuery
```
public void resetQuery()
```
    Reset the query (this does not close the query).
    
    Specified by:
    
    resetQuery in interface P2JQuery
  - getTableCount
```
public int getTableCount()
```
    Get the number of tables joined by this query.
    
    Specified by:
    
    getTableCount in interface P2JQuery
    
    Returns:
    
    Number of tables joined by this query.
  - getOffEndListeners
```
public java.util.ArrayList<QueryOffEndListener> getOffEndListeners()
```
    Get all the off-end listeners associated with this query.
    
    Specified by:
    
    getOffEndListeners in interface P2JQuery
    
    Returns:
    
    the off-end listeners associated with this query.
  - 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 HQL 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 wrapper.
  - setErrorIfNull
```
public void setErrorIfNull(boolean errorIfNull)
```
    Set a mode on the underlying buffers such that setting a null record into a buffer may or may not result in an error condition. This applies only to FIRST, LAST, and UNIQUE iteration types.
    If a query delegate has already been set, it is updated with the new setting immediately. The setting is remembered, such that any delegate assigned after this method is invoked will have this setting updated upon assignment to the query wrapper.
    
    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.
  - addComponent
```
public void addComponent(Joinable query)
```
    Add a joinable query to a compound query. If this is not the first component to be added to the query, its results will be joined to the immediately previous component by an inner join. This query will be iterated using the NEXT iteration type.
    
    Parameters:
    
    query - Query which will perform the fundamental work for this component when the compound query is iterated.
    
    Throws:
    
    java.lang.IllegalStateException - if this method is invoked during an iteration cycle or if delegate is not an instance of CompoundQuery.
    
    See Also:
    
    iterate()
  - addComponent
```
public void addComponent(Joinable query,
                         int iteration)
```
    Add a joinable query to a compound query, and specify the nature of the iteration which will be performed (first, last, next, etc.) on that component, when the compound query is iterated. If this is not the first component to be added to the query, its results will be joined to the immediately previous component by an inner join.
    
    Parameters:
    
    query - Query which will perform the fundamental work for this component when the compound query is iterated.
    
    iteration - A constant indicating the type of work to be performed upon an iteration of the compound query. This parameter determines whether the underlying query will be asked to perform a first, last, next, previous, or unique record retrieval.
    
    Throws:
    
    java.lang.IllegalStateException - if this method is invoked during an iteration cycle or if delegate is not an instance of CompoundQuery.
    
    See Also:
    
    iterate()
  - addComponent
```
public void addComponent(Joinable query,
                         int iteration,
                         boolean outer)
```
    Add a joinable query to a compound query, and specify the nature of the iteration which will be performed (first, last, next, etc.) on that component, when the compound query is iterated. If this is not the first component to be added to the query, the type of join performed with the immediately previous component is determined by the value of outer.
    
    Parameters:
    
    query - Query which will perform the fundamental work for this component when the compound query is iterated.
    
    iteration - A constant indicating the type of work to be performed upon an iteration of the compound query. This parameter determines whether the underlying query will be asked to perform a first, last, next, previous, or unique record retrieval.
    
    outer - true if this component should be joined to the previously added component via a left outer join; false if an inner join is required. Note that adding an inner join component will cause any previously added components added as outer joins to be reset to inner joins.
    
    Throws:
    
    java.lang.IllegalStateException - if this method is invoked during an iteration cycle or if delegate is not an instance of CompoundQuery.
    
    See Also:
    
    iterate()
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where)
```
    Add a component to a preselect query. The following defaults are used:
    - no substitution parameters
    - share lock
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo)
```
    Add a component to a preselect query. The following defaults are used:
    - no substitution parameters
    - share lock
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         DataModelObject inverse)
```
    Add a component to a preselect query. The following defaults are used:
    - no substitution parameters
    - share lock
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo,
                         DataModelObject inverse)
```
    Add a component to a preselect query. The following defaults are used:
    - no substitution parameters
    - share lock
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.Object[] args)
```
    Add a component to a preselect query. The following defaults are used:
    - share lock
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo,
                         java.lang.Object[] args)
```
    Add a component to a preselect query. The following defaults are used:
    - share lock
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         DataModelObject inverse,
                         java.lang.Object[] args)
```
    Add a component to a preselect query. The following defaults are used:
    - share lock
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo,
                         DataModelObject inverse,
                         java.lang.Object[] args)
```
    Add a component to a preselect query. The following defaults are used:
    - share lock
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         LockType lockType)
```
    Add a component to a preselect query. The following defaults are used:
    - no substitution parameters
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo,
                         LockType lockType)
```
    Add a component to a preselect query. The following defaults are used:
    - no substitution parameters
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         DataModelObject inverse,
                         LockType lockType)
```
    Add a component to a preselect query. The following defaults are used:
    - no substitution parameters
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo,
                         DataModelObject inverse,
                         LockType lockType)
```
    Add a component to a preselect query. The following defaults are used:
    - no substitution parameters
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.Object[] args,
                         LockType lockType)
```
    Add a component to a preselect query. The following defaults are used:
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo,
                         java.lang.Object[] args,
                         LockType lockType)
```
    Add a component to a preselect query. The following defaults are used:
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         DataModelObject inverse,
                         java.lang.Object[] args,
                         LockType lockType)
```
    Add a component to a preselect query. The following defaults are used:
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo,
                         DataModelObject inverse,
                         java.lang.Object[] args,
                         LockType lockType)
```
    Add a component to a preselect query. The following defaults are used:
    - inner join
    - NEXT iteration type
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.Object[] args,
                         LockType lockType,
                         int iteration,
                         boolean outer)
```
    Add a component to a preselect query.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    iteration - Iteration/retrieval mode for this component of the query. At this time, only NEXT is supported. Future support for FIRST, LAST, and UNIQUE is expected.
    
    outer - true if an outer join is required. At this time, only inner joins are supported. Future support for outer joins is expected.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if outer is true (temporary); if iteration is not NEXT (temporary); if dmo's associated database is different than that of a previously added component's database (cross-database preselect joins are not possible).
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo,
                         java.lang.Object[] args,
                         LockType lockType,
                         int iteration,
                         boolean outer)
```
    Add a component to a preselect query.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    iteration - Iteration/retrieval mode for this component of the query. At this time, only NEXT is supported. Future support for FIRST, LAST, and UNIQUE is expected.
    
    outer - true if an outer join is required. At this time, only inner joins are supported. Future support for outer joins is expected.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if outer is true (temporary); if iteration is not NEXT (temporary); if dmo's associated database is different than that of a previously added component's database (cross-database preselect joins are not possible).
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         DataModelObject inverse,
                         java.lang.Object[] args,
                         LockType lockType,
                         int iteration,
                         boolean outer)
```
    Add a component to a preselect query.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    iteration - Iteration/retrieval mode for this component of the query. At this time, only NEXT is supported. Future support for FIRST, LAST, and UNIQUE is expected.
    
    outer - true if an outer join is required. At this time, only inner joins are supported. Future support for outer joins is expected.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if outer is true (temporary); if iteration is not NEXT (temporary); if dmo's associated database is different than that of a previously added component's database (cross-database preselect joins are not possible).
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addComponent
```
public void addComponent(DataModelObject dmo,
                         java.lang.String where,
                         java.lang.String indexInfo,
                         DataModelObject inverse,
                         java.lang.Object[] args,
                         LockType lockType,
                         int iteration,
                         boolean outer)
```
    Add a component to a preselect query.
    
    Parameters:
    
    dmo - DMO proxy which defines buffer and record type.
    
    where - HQL where clause. May be null.
    
    indexInfo - Index information string as it is returned by INDEX-INFORMATION. May be null if it is not an OPEN QUERY case or if you don't need debug information about selected indexes.
    
    inverse - DMO to which this query should join via a foreign relation. May be null.
    
    args - Substitution parameters to be inserted into placeholders within the where clause.
    
    lockType - Lock type to apply to records retrieved by this component of the query.
    
    iteration - Iteration/retrieval mode for this component of the query. At this time, only NEXT is supported. Future support for FIRST, LAST, and UNIQUE is expected.
    
    outer - true if an outer join is required. At this time, only inner joins are supported. Future support for outer joins is expected.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if outer is true (temporary); if iteration is not NEXT (temporary); if dmo's associated database is different than that of a previously added component's database (cross-database preselect joins are not possible).
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - addWhereExpression
```
public void addWhereExpression(java.util.function.Supplier<logical> whereExpr)
```
    Add a client-side where expression to a preselect query. Each initial query result found by the server must be accepted by this expression before becoming a part of the query's final result set.
    
    Parameters:
    
    whereExpr - Client-side where clause expression. May not be null.
    
    Throws:
    
    java.lang.NullPointerException - if whereExpr is null.
    
    java.lang.IllegalStateException - if delegate is not an instance of PreselectQuery.
  - setIterationType
```
public void setIterationType(int iteration)
```
    Set the iteration type for the most recently added query component to a preselect query.
    
    Parameters:
    
    iteration - Retrieval mode from QueryConstants. Must not be FIRST or LAST (use setIterationType(int, String) instead for these types.
    
    Throws:
    
    java.lang.IllegalStateException - if no component has yet been added; or if delegate is not an instance of PreselectQuery.
    
    java.lang.IllegalArgumentException - if iteration type is FIRST or LAST.
  - setIterationType
```
public void setIterationType(int iteration,
                             java.lang.String sort)
```
    Set the iteration type for the most recently added query component to a preselect query.
    
    Parameters:
    
    iteration - Retrieval mode from QueryConstants.
    
    sort - Order by clause which should be associated with the most recently added query component. Must be non-null for iteration types FIRST and LAST.
    
    Throws:
    
    java.lang.IllegalStateException - if no component has yet been added; or if delegate is not an instance of PreselectQuery.
    
    java.lang.IllegalArgumentException - if iteration type is FIRST or LAST, but sort is null, or if sort represents an invalid HQL order by expression.
  - addSortCriterion
```
public void addSortCriterion(Resolvable sort)
```
    Add a single sort criterion, in the form of a Resolvable object which is resolved at sort time. It is the value of the resolved result which is used for the sort.
    The sort is ascending, from lowest resolved value to highest.
    The delegate must be an instance of PresortDelegate
    
    Parameters:
    
    sort - A resolvable object whose resolved result is used for sorting.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PresortDelegate.
  - addSortCriterion
```
public void addSortCriterion(Resolvable sort,
                             boolean descending)
```
    Add a single sort criterion, in the form of a Resolvable object which is resolved at runtime. It is the value of the resolved result which is used for the sort.
    The delegate must be an instance of PresortDelegate
    
    Parameters:
    
    sort - A resolvable object whose resolved result is used for sorting.
    
    descending - if true, the sort is descending, from highest resolved value to lowest; otherwise, the sort is ascending.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PresortDelegate.
  - 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.
  - enableBreakGroups
```
public void enableBreakGroups()
```
    Enable all sort criteria set for this query to act as break group categories. When the query's results are presorted, the contents of each break group are determined.
    The delegate must be an instance of PresortDelegate
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PresortDelegate.
  - 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 iterate() 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
  - valid
```
public boolean valid()
```
    Reports if this query (that is, its delegate query) is valid for use.
    
    Specified by:
    
    valid in interface WrappedResource
    
    Returns:
    
    true if this query's delegate is valid for use.
  - iterate
```
public void iterate()
```
    Advance a compound query, triggering one or more of the underlying queries to retrieve a new record. This produces a virtual, composite row of results which is the combination of the records retrieved by each component query.
    
    Throws:
    
    QueryOffEndException - if no more records can be retrieved by the underlying queries.
    
    ErrorConditionException - if an underlying query triggers an error.
    
    java.lang.IllegalStateException - if delegate is not an instance of CompoundQuery.
  - first
```
public boolean first()
```
    Navigate to the first record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters and lock type.
    
    Specified by:
    
    first in interface P2JQuery
    
    Returns:
    
    true if query could retrive the first record succefully; 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.
  - first
```
public boolean first(LockType lockType)
```
    Navigate to the first record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters, but override the default lock type with that provided.
    
    Specified by:
    
    first in interface P2JQuery
    
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrive the first record succefully; 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.
  - first
```
public boolean first(boolean iterating)
```
    Retrieve the first virtual, composite row of results for a compound query.
    This is a combination of records retrieved by each component query. If the compound query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    iterating - true if this method is being invoked within the context of an iterating loop, which can only be exited by raising an end condition; false if end condition should not be raised, even if no further advancement of the composite result is possible.
    
    Throws:
    
    QueryOffEndException - if no more results were available in iterating mode.
    
    ErrorConditionException - if an underlying query triggers an error.
    
    java.lang.IllegalStateException - if delegate is not an instance of CompoundQuery.
  - first
```
public boolean first(boolean iterating,
                     LockType lockType)
```
    Retrieve the first virtual, composite row of results for a compound query, overriding the lock type to apply to each underlying query.
    This is a combination of records retrieved by each component query. If the compound query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    iterating - true if this method is being invoked within the context of an iterating loop, which can only be exited by raising an end condition; false if end condition should not be raised, even if no further advancement of the composite result is possible.
    
    lockType - Lock type which should override that of any underlying query.
    
    Throws:
    
    QueryOffEndException - if no more results were available in iterating mode.
    
    ErrorConditionException - if an underlying query triggers an error.
    
    java.lang.IllegalStateException - if delegate is not an instance of CompoundQuery.
  - first
```
public boolean first(java.lang.Object[] values)
```
    Navigate to the first record which meets the query criteria and retrieve it into its record buffer. Use the default lock type, but override the default substitution parameters with those provided.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    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.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - first
```
public boolean first(java.lang.Object[] values,
                     LockType lockType)
```
    Navigate to the first record which meets the query criteria and retrieve it into its record buffer. Override both the default substitution parameters, and the default lock type with those provided.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    lockType - Lock type to acquire for the retrieved record.
    
    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.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - last
```
public boolean last()
```
    Navigate to the last record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters and lock type.
    
    Specified by:
    
    last in interface P2JQuery
    
    Returns:
    
    true if query could retrive the last record succefully; 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.
  - last
```
public boolean last(LockType lockType)
```
    Navigate to the last record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters, but override the default lock type with that provided.
    
    Specified by:
    
    last in interface P2JQuery
    
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrive the last record succefully; 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.
  - last
```
public void last(boolean iterating)
```
    Retrieve the last virtual, composite row of results for a compound query.
    This is a combination of records retrieved by each component query. If the compound query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    iterating - true if this method is being invoked within the context of an iterating loop, which can only be exited by raising an end condition; false if end condition should not be raised, even if no further advancement of the composite result is possible.
    
    Throws:
    
    QueryOffEndException - if no more results were available in iterating mode.
    
    ErrorConditionException - if an underlying query triggers an error.
    
    java.lang.IllegalStateException - if delegate is not an instance of CompoundQuery.
  - last
```
public void last(boolean iterating,
                 LockType lockType)
```
    Retrieve the last virtual, composite row of results for a compound query, overriding the lock type to apply to each underlying query.
    This is a combination of records retrieved by each component query. If the compound query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    iterating - true if this method is being invoked within the context of an iterating loop, which can only be exited by raising an end condition; false if end condition should not be raised, even if no further advancement of the composite result is possible.
    
    lockType - Lock type which should override that of any underlying query.
    
    Throws:
    
    QueryOffEndException - if no more results were available in iterating mode.
    
    ErrorConditionException - if an underlying query triggers an error.
    
    java.lang.IllegalStateException - if delegate is not an instance of CompoundQuery.
  - last
```
public void last(java.lang.Object[] values)
```
    Navigate to the last record which meets the query criteria and retrieve it into its record buffer. Use the default lock type, but override the default substitution parameters with those provided.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    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.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - last
```
public void last(java.lang.Object[] values,
                 LockType lockType)
```
    Navigate to the last record which meets the query criteria and retrieve it into its record buffer. Override both the default substitution parameters, and the default lock type with those provided.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    lockType - Lock type to acquire for the retrieved record.
    
    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.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - next
```
public boolean next()
```
    Navigate to the next record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters and lock type.
    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.
    
    Specified by:
    
    next in interface P2JQuery
    
    Returns:
    
    true if query could retrive the next record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
  - next
```
public boolean next(LockType lockType)
```
    Navigate to the next record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters, but override the default lock type with that provided.
    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.
    
    Specified by:
    
    next in interface P2JQuery
    
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrive the next record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
  - next
```
public boolean next(boolean iterating)
```
    Retrieve the next virtual, composite row of results for a compound query.
    This is a combination of records retrieved by each component query. If the compound query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    iterating - true if this method is being invoked within the context of an iterating loop, which can only be exited by raising an end condition; false if end condition should not be raised, even if no further advancement of the composite result is possible.
    
    Throws:
    
    QueryOffEndException - if no more results were available in iterating mode.
    
    ErrorConditionException - if an underlying query triggers an error.
    
    java.lang.IllegalStateException - if delegate is not an instance of CompoundQuery.
  - next
```
public boolean next(boolean iterating,
                    LockType lockType)
```
    Retrieve the next virtual, composite row of results for a compound query, overriding the lock type to apply to each underlying query.
    This is a combination of records retrieved by each component query. If the compound query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    iterating - true if this method is being invoked within the context of an iterating loop, which can only be exited by raising an end condition; false if end condition should not be raised, even if no further advancement of the composite result is possible.
    
    lockType - Lock type which should override that of any underlying query.
    
    Throws:
    
    QueryOffEndException - if no more results were available in iterating mode.
    
    ErrorConditionException - if an underlying query triggers an error.
    
    java.lang.IllegalStateException - if delegate is not an instance of CompoundQuery.
  - next
```
public boolean next(java.lang.Object[] values)
```
    Navigate to the next record which meets the query criteria and retrieve it into its record buffer. Use the default lock type, but override the default substitution parameters with those provided.
    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.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - next
```
public boolean next(java.lang.Object[] values,
                    LockType lockType)
```
    Navigate to the next record which meets the query criteria and retrieve it into its record buffer. Override both the default substitution parameters, and the default lock type with those provided.
    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.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    lockType - Lock type to acquire for the retrieved record.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - previous
```
public boolean previous()
```
    Navigate to the previous record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters and lock type.
    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.
    
    Specified by:
    
    previous in interface P2JQuery
    
    Returns:
    
    true if query could retrive the previous record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
  - previous
```
public boolean previous(LockType lockType)
```
    Navigate to the previous record which meets the query criteria and retrieve it into its record buffer. Use the default substitution parameters, but override the default lock type with that provided.
    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.
    
    Specified by:
    
    previous in interface P2JQuery
    
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrive the previous record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
  - previous
```
public boolean previous(boolean iterating)
```
    Retrieve the previous virtual, composite row of results for a compound query.
    This is a combination of records retrieved by each component query. If the compound query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    iterating - true if this method is being invoked within the context of an iterating loop, which can only be exited by raising an end condition; false if end condition should not be raised, even if no further advancement of the composite result is possible.
    
    Throws:
    
    QueryOffEndException - if no more results were available in iterating mode.
    
    ErrorConditionException - if an underlying query triggers an error.
    
    java.lang.IllegalStateException - if delegate is not an instance of CompoundQuery.
  - previous
```
public boolean previous(boolean iterating,
                        LockType lockType)
```
    Retrieve the previous virtual, composite row of results for a compound query, overriding the lock type to apply to each underlying query.
    This is a combination of records retrieved by each component query. If the compound query involves outer joins, some of the underlying buffers may be empty when this method returns.
    
    Parameters:
    
    iterating - true if this method is being invoked within the context of an iterating loop, which can only be exited by raising an end condition; false if end condition should not be raised, even if no further advancement of the composite result is possible.
    
    lockType - Lock type which should override that of any underlying query.
    
    Throws:
    
    QueryOffEndException - if no more results were available in iterating mode.
    
    ErrorConditionException - if an underlying query triggers an error.
    
    java.lang.IllegalStateException - if delegate is not an instance of CompoundQuery.
  - previous
```
public boolean previous(java.lang.Object[] values)
```
    Navigate to the previous record which meets the query criteria and retrieve it into its record buffer. Use the default lock type, but override the default substitution parameters with those provided.
    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.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - previous
```
public boolean previous(java.lang.Object[] values,
                        LockType lockType)
```
    Navigate to the previous record which meets the query criteria and retrieve it into its record buffer. Override both the default substitution parameters, and the default lock type with those provided.
    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.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    lockType - Lock type to acquire for the retrieved record.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record retrieval.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - current
```
public boolean current()
```
    Reload the record most recently loaded into the backing record buffer, if any. Use the default lock type.
    
    Specified by:
    
    current in interface P2JQuery
    
    Returns:
    
    true if query could retrive the current record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record reload.
  - current
```
public boolean current(LockType lockType)
```
    Reload the record most recently loaded into the backing record buffer, if any. Override the default lock type.
    
    Specified by:
    
    current in interface P2JQuery
    
    Parameters:
    
    lockType - New lock type to apply to the record.
    
    Returns:
    
    true if query could retrive the current record succefully; false if unsuccessful and lenientOffEnd is set on true.
    
    Throws:
    
    ErrorConditionException - if an error occurred during record reload, or the lock could not be transitioned to the requested type.
  - unique
```
public boolean unique()
```
    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. Use the default substitution parameters and lock type.
    
    Specified by:
    
    unique in interface P2JQuery
    
    Returns:
    
    true if query could retrive the unique record succefully; 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.
  - unique
```
public boolean unique(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. Use the default substitution parameters, but override the default lock type with that provided.
    
    Specified by:
    
    unique in interface P2JQuery
    
    Parameters:
    
    lockType - Lock type to acquire for the retrieved record.
    
    Returns:
    
    true if query could retrive the unique record succefully; 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.
  - unique
```
public boolean unique(java.lang.Object[] values)
```
    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. Use the default lock type, but override the default substitution parameters with those provided.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    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.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - unique
```
public boolean unique(java.lang.Object[] values,
                      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. Override both the default substitution parameters, and the default lock type with those provided.
    The delegate must be an instance of RandomAccessQuery
    
    Parameters:
    
    values - Substitution values to use when issuing HQL queries.
    
    lockType - Lock type to acquire for the retrieved record.
    
    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.
    
    java.lang.IllegalStateException - if delegate is not an instance of RandomAccessQuery.
  - 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.
  - 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.
  - 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 - 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.
  - 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 - 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.
  - 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.
  - 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.
  - 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 - 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.
  - 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 - 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.
  - 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 opened or closed.
    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.
  - addOpenedListener
```
public void addOpenedListener(P2JQuery.QueryOpenedListener listener)
```
    Register a listener to receive notifications about the query has been opened.
    
    Parameters:
    
    listener - The listener to be notified.
  - removeOpenedListener
```
public void removeOpenedListener(P2JQuery.QueryOpenedListener listener)
```
    De-register a listener to receive notifications about the query has been opened.
    
    Parameters:
    
    listener - The listener to be removed.
  - 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(ResultListHandler resultListHandler)
```
    Sets an external result list handler and marks the query as browsed.
    
    Parameters:
    
    resultListHandler - External result list handler.
  - 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.
  - isBrowsed
```
public boolean isBrowsed()
```
    Is this query associated with a browse widget or not?
    
    Specified by:
    
    isBrowsed in interface P2JQuery
    
    Returns:
    
    true if the query has an associated browse widget,
  - repositionByID
```
public void repositionByID(recid id)
```
    Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified primary key ID. A request to retrieve the previous result will retrieve the result immediately previous to this, if any, in the results list.
    
    Specified by:
    
    repositionByID in interface P2JQuery
    
    Parameters:
    
    id - A primary key ID, representing the target record (in the case of a join, this ID is associated with the left-most record in the join).
    
    Throws:
    
    ErrorConditionException - if the specified ID represents the unknown value.
  - repositionByID
```
public void repositionByID(rowid id1,
                           rowid... joinIDs)
```
    Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs. A request to retrieve the previous result will retrieve the result immediately previous to this, if any, in the results list.
    
    Specified by:
    
    repositionByID 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. If an array element is unknown, this element and all subsequent elements are ignored.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query; if any of the specified IDs represents the unknown value.
  - repositionByID
```
public boolean repositionByID(java.lang.Long... joinIDs)
```
    Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs. A request to retrieve the previous result will retrieve the result immediately previous to this, if any, in the results list. Note: This is not public API.
    
    Specified by:
    
    repositionByID in interface P2JQuery
    
    Parameters:
    
    joinIDs - A set of primary key IDs, arranged from left to right to coincide with the records being joined by the underlying query.
    
    Returns:
    
    true on success.
    
    Throws:
    
    ErrorConditionException - if any of the specified IDs represents the unknown value.
  - reposition
```
public void reposition(NumberType row)
```
    Reposition the cursor to the specified row in the result set. The row indicates the position between two results, such that a call to retrieve the next record will get the result at the specified row, and a call to retrieve the previous result will get the result before the new position.
    
    Specified by:
    
    reposition in interface P2JQuery
    
    Parameters:
    
    row - 1-based index of the target position.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query; if row represents unknown value.
  - reposition
```
public void reposition(int row)
```
    Reposition the query to the specified row in the result set. The row indicates the position between two results, such that a call to retrieve the next record will get the record after the new position, and a call to retrieve the previous record will get the record before the new position.
    
    Specified by:
    
    reposition in interface P2JQuery
    
    Parameters:
    
    row - 1-based index of the target position.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query.
  - forward
```
public boolean forward(NumberType rows)
```
    Advance the current cursor position forward by the specified number of rows. This will always leave the cursor between two results. For example, given a request to move 1 row forward:
    - if the cursor currently is positioned directly on a result, this would move it ahead one and a half positions, to just beyond the following result;
    - if the cursor currently is positioned between two results, this would move it ahead one position, to just beyond the following result.
    Specified by:
    
    forward in interface P2JQuery
    
    Parameters:
    
    rows - Number of rows to scroll the cursor forward.
    
    Returns:
    
    true if operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query; if rows represents the unknown value.
  - forward
```
public boolean forward(int rows)
```
    Advance the current cursor position forward by the specified number of rows. This will always leave the cursor between two results. For example, given a request to move 1 row forward:
    - if the cursor currently is positioned directly on a result, this would move it ahead one and a half positions, to just beyond the following result;
    - if the cursor currently is positioned between two results, this would move it ahead one position, to just beyond the following result.
    Specified by:
    
    forward in interface P2JQuery
    
    Parameters:
    
    rows - Number of rows to scroll the cursor forward.
    
    Returns:
    
    true if operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query.
  - backward
```
public boolean backward(NumberType rows)
```
    Move the current cursor position backward by the specified number of rows. This will always leave the cursor between two results. For example, given a request to move 1 row backward:
    - if the cursor currently is positioned directly on a result, this would move it back one half position, to just before the current result;
    - if the cursor currently is positioned between two results, this would move it back one position, to just before the current result.
    Specified by:
    
    backward in interface P2JQuery
    
    Parameters:
    
    rows - Number of rows to scroll the cursor backward.
    
    Returns:
    
    true if operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query; if rows represents the unknown value.
  - backward
```
public boolean backward(int rows)
```
    Move the current cursor position backward by the specified number of rows. This will always leave the cursor between two results. For example, given a request to move 1 row backward:
    - if the cursor currently is positioned directly on a result, this would move it back one half position, to just before the current result;
    - if the cursor currently is positioned between two results, this would move it back one position, to just before the current result.
    Specified by:
    
    backward in interface P2JQuery
    
    Parameters:
    
    rows - Number of rows to scroll the cursor backward.
    
    Returns:
    
    true if operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query.
  - size
```
public integer size()
```
    Get the current size of the cached results list. However, since this cache is built progressively as the query is scrolled, repositioned, and naturally navigated, this does not necessarily represent the full count of results which may satisfy the query.
    
    Specified by:
    
    size in interface P2JQuery
    
    Returns:
    
    Current results list size or unknown value if the query is not open.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query.
  - 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 recursive DATA-RELATION the query is to FILL for
  - currentRow
```
public integer currentRow()
```
    Progress-compatible function that returns the 1-based index of the current row in the result set. This is the index of the entry at or before which the cursor currently is positioned.
    
    Specified by:
    
    currentRow in interface P2JQuery
    
    Returns:
    
    Unknown value if the query is not open or result set is empty. 1 if the query is positioned before the first record. A value 1 greater than the number of rows in the query result set if the query is positioned beyond the last record. Otherwise returns the number of the current row in the query result set.
  - currentRowImpl
```
public integer currentRowImpl()
```
    Get the 1-based index of the current row in the result set. This is the index of the entry at or before which the cursor currently is positioned.
    
    Specified by:
    
    currentRowImpl in interface P2JQuery
    
    Returns:
    
    Current row or the unknown value if the current row cannot be determined. The current row cannot be determined if the results list is empty, or if the cursor currently is in backward scroll mode.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query.
  - 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.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query.
  - _isOffEnd
```
public boolean _isOffEnd()
```
    Indicate whether the cursor has run off one or the other end of the associated query's list of available results. If true, this indicates that the query cannot produce any more results in the current scroll direction.
    
    Specified by:
    
    _isOffEnd in interface P2JQuery
    
    Returns:
    
    true if the cursor is off either end of its query's results list.
    
    Throws:
    
    ErrorConditionException - if this query is not a scrolling query.
  - getOffEnd
```
public OffEnd getOffEnd()
```
    Get the off-end status of the query, which indicates whether the query has run off either end of its results.
    
    Specified by:
    
    getOffEnd in interface P2JQuery
    
    Returns:
    
    One of the OffEnd constants NONE, FRONT, or BACK.
  - isFirst
```
public logical isFirst()
```
    Determine whether the query result row currently being visited is the first row in the presorted results list.
    The delegate must be an instance of PresortDelegate
    
    Returns:
    
    true if the current result row is the first row, else false.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PresortDelegate.
  - isFirstOfGroup
```
public logical isFirstOfGroup(Resolvable key)
```
    Determine whether the query result row currently being visited is the first row within a break group whose category is identified by the specified resolvable object.
    The delegate must be an instance of PresortDelegate
    
    Parameters:
    
    key - Break group category key. Must be the same object reference as was specified previously when invoking one of the addSortCriterion method variants.
    
    Returns:
    
    true if current row is first in a break group; false if it is not; unknown value if break groups have not been enabled.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PresortDelegate.
  - isFirstOfGroup
```
public logical isFirstOfGroup(integer level)
```
    Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
    
    Specified by:
    
    isFirstOfGroup in interface P2JQuery
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria. Must not be unknown value.
    
    Returns:
    
    true if the current row is first in the result set or within the specified break group; else false.
  - isFirstOfGroup
```
public logical isFirstOfGroup(int level)
```
    Determine whether the query result row currently being visited is the first row of the query's result set or the first row within a break group whose category is identified by the specified BREAK-BY level.
    
    Specified by:
    
    isFirstOfGroup in interface P2JQuery
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria.
    
    Returns:
    
    true if the current row is first in the result set or within the specified break group; else false.
  - isLast
```
public logical isLast()
```
    Determine whether the query result row currently being visited is the last row in the presorted results list.
    The delegate must be an instance of PresortDelegate
    
    Returns:
    
    true if the current result row is the last row, else false.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PresortDelegate.
  - isLastOfGroup
```
public logical isLastOfGroup(Resolvable key)
```
    Determine whether the query result row currently being visited is the first row within a break group whose category is identified by the specified resolvable object.
    The delegate must be an instance of PresortDelegate
    
    Parameters:
    
    key - Break group category key. Must be the same object reference as was specified previously when invoking one of the addSortCriterion method variants.
    
    Returns:
    
    true if current row is first in a break group; false if it is not; unknown value if break groups have not been enabled.
    
    Throws:
    
    java.lang.IllegalStateException - if delegate is not an instance of PresortDelegate.
  - isLastOfGroup
```
public logical isLastOfGroup(integer level)
```
    Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
    
    Specified by:
    
    isLastOfGroup in interface P2JQuery
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria. Must not be unknown value.
    
    Returns:
    
    true if the current row is last in the result set or within the specified break group; else false.
  - isLastOfGroup
```
public logical isLastOfGroup(int level)
```
    Determine whether the query result row currently being visited is the last row of the query's result set or the last row within a break group whose category is identified by the specified BREAK-BY level.
    
    Specified by:
    
    isLastOfGroup in interface P2JQuery
    
    Parameters:
    
    level - Break group level, where 0 is the whole query, 1 is the first BREAK-BY sort criterion, etc. Must not be negative or greater than the number of sort criteria.
    
    Returns:
    
    true if the current row is last in the result set or within the specified break group; else false.
  - isPreselect
```
public boolean isPreselect()
```
    Indicate whether this query preselects all of its results.
    
    Specified by:
    
    isPreselect in interface P2JQuery
    
    Returns:
    
    true if the query preselects its results; false if the query's results are dynamically navigated.
  - isNativelyPreselect
```
public boolean isNativelyPreselect()
```
    Indicate whether this query is a preselect query by its nature.
    
    Specified by:
    
    isNativelyPreselect in interface P2JQuery
    
    Returns:
    
    true.
  - 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.
  - notifyListeners
```
@Deprecated
public void notifyListeners()
```
    Deprecated. Use #open() instead.
    
    Notify all registered listeners that query is repositioned in case if query is attached to browse widget.
  - isStandalone
```
public boolean isStandalone()
```
    Indicate whether this query stands alone, or is the component of another query, or is wrapped by a query wrapper.
    
    Specified by:
    
    isStandalone in interface P2JQuery
    
    Returns:
    
    true; query wrappers may not themselves be wrapped.
  - 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 or container which contains it.
    Instances of QueryWrapper may not be wrapped in other queries or query wrappers, so this implementation throws an exception if this method is invoked with a parameter of true.
    
    Specified by:
    
    setStandalone in interface P2JQuery
    
    Parameters:
    
    standalone - true to set query as standalone; false to set query as contained.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if standalone is set to true.
  - cleanup
```
public void cleanup()
```
    Delegate cleanup processing to the query wrapped by this object.
    
    Specified by:
    
    cleanup in interface P2JQuery
    
    See Also:
    
    P2JQuery.cleanup()
  - asHandle
```
public handle asHandle()
```
    Generate a handle to the query object. Returns a handle of a query object.
    
    Returns:
    
    query handle
  - 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
  - bufferHandleNative
```
public Buffer bufferHandleNative()
```
    Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH). Returns a handle of the first buffer of a query object.
    
    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
  - getBufferByIndex
```
public Buffer getBufferByIndex(int bufferSequenceNumber)
```
    Conversion of GET-BUFFER-HANDLE() method (KW_GET_BUFH). Returns a particular buffer of a query object.
    
    Parameters:
    
    bufferSequenceNumber - buffer-sequence-number. An INTEGER that represents the sequence number of the desired buffer.
    
    Returns:
    
    buffer object
  - 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(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.
  - 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 operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
  - 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.
  - 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 operation was successful and the cursor was moved the exact amount of rows as specified by the parameter. If false is returned then it is possible that cursor's position was moved but not with rows rows.
  - 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.
  - queryRepositionByID
```
public logical queryRepositionByID(character rowId)
```
    Conversion of REPOSITION-TO-ROWID() method (KW_REPOS_2I). Reposition the cursor such that a request to retrieve the next result will retrieve the result which matches the specified array of primary key IDs. A request to retrieve the previous result will retrieve the result immediately previous to this, if any, in the results list.
    
    Specified by:
    
    queryRepositionByID in interface P2JQuery
    
    Parameters:
    
    rowId - A character representation of this rowid.
    
    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
    
    Returns:
    
    Number of rows currently in the results list of a scrolling query. If the query is not open or it is not scrolling, returns the unknown value.
  - 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
  - addBuffer
```
public logical addBuffer(character bufName)
```
    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:
    
    bufName - A buffer name use to identify a buffer to be added.
    
    Returns:
    
    true on success
  - addBuffer
```
public logical addBuffer(java.lang.String bufName)
```
    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:
    
    bufName - A buffer name use to identify a buffer to be added.
    
    Returns:
    
    true on success
  - addBuffer
```
public logical addBuffer(Buffer buf,
                         boolean staticCall)
```
    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.
    
    Parameters:
    
    buf - A buffer to add.
    
    staticCall - true if it is internal call for a static query.
    
    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
  - setBuffers
```
public logical setBuffers(java.lang.Object... 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.
  - getADMData
```
public character getADMData()
```
    Get the value of the ADM-DATA attribute.
    
    Specified by:
    
    getADMData in interface ADMData
    
    Returns:
    
    See above.
  - setADMData
```
public void setADMData(java.lang.String value)
```
    Set the value of the ADM-DATA attribute.
    
    Specified by:
    
    setADMData in interface ADMData
    
    Parameters:
    
    value - The new value.
  - setADMData
```
public void setADMData(character value)
```
    Set the value of the ADM-DATA attribute.
    
    Specified by:
    
    setADMData in interface ADMData
    
    Parameters:
    
    value - The new value.
  - getUniqueID
```
public integer getUniqueID()
```
    Gets the the unique ID number associated to this object by the underlying system. Not the same as the handle value itself.
    
    Specified by:
    
    getUniqueID in interface UniqueID
    
    Returns:
    
    The integer number of the children.
  - resourceDelete
```
protected boolean resourceDelete()
```
    Delete the resource.
    
    Overrides:
    
    resourceDelete in class HandleResource
    
    Returns:
    
    true if the resource was deleted.
  - _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:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - 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:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - 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 thgetPe 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(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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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.
  - 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:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - 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.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - 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:
    
    java.lang.IllegalArgumentException - if lock has not valid internal value.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - 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:
    
    java.lang.IllegalArgumentException - if lock or nowait have not valid internal values.
  - getCurrent
```
public logical getCurrent()
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches 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). Refetches 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.
  - getCurrent
```
public logical getCurrent(NumberType lock)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches 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.
  - getCurrent
```
public logical getCurrent(LockType lockType)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches 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). Refetches 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.
  - getCurrent
```
public logical getCurrent(NumberType lock,
                          long nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches 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.
  - getCurrent
```
public logical getCurrent(long lock,
                          NumberType nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches 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.
  - getCurrent
```
public logical getCurrent(NumberType lock,
                          NumberType nowait)
```
    Conversion of GET-CURRENT() method (KW_GET_CUR). Refetches 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.
  - 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
    
    Specified by:
    
    createResultListEntry in interface ResultListHandler
    
    Returns:
    
    true on success.
  - createResultListEntryWorker
```
public logical createResultListEntryWorker()
```
    Calls delegate's P2JQuery.createResultListEntry().
    
    Returns:
    
    result of execution of delegate's P2JQuery.createResultListEntry().
  - deleteResultListEntryWorker
```
public logical deleteResultListEntryWorker()
```
    Calls delegate's P2JQuery.deleteResultListEntry().
    
    Returns:
    
    result of execution of delegate's P2JQuery.deleteResultListEntry().
  - 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
    
    Specified by:
    
    deleteResultListEntry in interface ResultListHandler
    
    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:
    
    true on success.
  - 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.
  - 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.
  - 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.
  - 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.
  - isFillingBrowseRows
```
public boolean isFillingBrowseRows()
```
    Checks whether 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:
    
    isFillingBrowseRows in interface P2JQuery
    
    Returns:
    
    true if the deleted rows will not be returned because the query is managed by the browse widget.
    
    See Also:
    
    P2JQuery.setFillingBrowseRows(boolean)
  - 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.
  - setCallbackProcedure
```
public logical setCallbackProcedure(java.lang.String eventName,
                                    java.lang.String callback,
                                    handle context)
```
    Associates an internal procedure with an ABL callback event.
    
    Specified by:
    
    setCallbackProcedure in interface CallbackProcedure
    
    Parameters:
    
    eventName - The eventName of the event.
    
    callback - The eventName of the internal procedure associated with the callback event.
    
    context - A handle to a procedure that contains the internal procedure specified by callback. If not specified, THIS-PROCEDURE is used as the procedure context.
    
    Returns:
    
    true when the method ends with success.
  - setCallback
```
public logical setCallback(java.lang.String callbackName,
                           java.lang.String routineName,
                           object<?> context)
```
    Configures a callback. Creates an association between a method within a class instance or an internal procedure within a persistent procedure, with an ABL callback event.
    
    Specified by:
    
    setCallback in interface CallbackProcedure
    
    Parameters:
    
    callbackName - The name of a callback.
    
    routineName - The name of a method or an internal procedure to be associated.
    
    context - The context in which the callback will be executed.
    
    Returns:
    
    true if callbackName is a correct callback name. The rest of parameters are ignored (note: manual states otherwise).
  - applyCallback
```
public logical applyCallback(java.lang.String eventName)
```
    Applies a callback procedure, which allows execution of a defined event without duplicating the event procedure definition.
    
    Specified by:
    
    applyCallback in interface CallbackProcedure
    
    Parameters:
    
    eventName - The event whose callback will be called.
    
    Returns:
    
    true if operation is successful.
  - getCallbackProcName
```
public character getCallbackProcName(java.lang.String eventName)
```
    Retrieves the name of the internal procedure associated with the ABL callback for the specified event.
    
    Specified by:
    
    getCallbackProcName in interface CallbackProcedure
    
    Parameters:
    
    eventName - The name of the event.
    
    Returns:
    
    the name of the internal procedure associated with specified event.
  - getCallbackProcContext
```
public handle getCallbackProcContext(java.lang.String eventName)
```
    Retrieves the handle of the procedure that contains the internal procedure associated with the ABL callback for the specified event
    
    Specified by:
    
    getCallbackProcContext in interface CallbackProcedure
    
    Parameters:
    
    eventName - The name of the event.
    
    Returns:
    
    a handle to the procedure that contains the callback procedure.
  - 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.
  - getRecordBuffers
```
public RecordBuffer[] getRecordBuffers()
```
    Get a list of all buffers in this query.
    
    Specified by:
    
    getRecordBuffers in interface P2JQuery
    
    Returns:
    
    The list of buffers.
  - maybeFireCallback
```
private void maybeFireCallback()
```
    Test whether the OFF-END event occurred and if so, fire the callback if one is defined.
  - addBuffers
```
private void addBuffers(Joinable query,
                        boolean clear)
```
    Add the buffers associated with the given query to this QUERY's buffer list.
    Will be a no-op when this is a dynamic query.
    
    Parameters:
    
    query - The P2J query from which the buffers are loaded.
    
    clear - When true, it will clear the buffers list and the predicate.
  - parseBuffer
```
private Buffer parseBuffer(BufferManager bm,
                           java.lang.String bufName,
                           int bufIdx)
```
    Identify the buffer which matches the given buffer name. Use an instance of the BufferManager to identify the proper buffer.
    
    Parameters:
    
    bm - An instance of the BufferManager. This can be null, case in which it will be initialized with a buffer manager from the local context.
    
    bufName - The buffer name which should be used to identify the searched buffer.
    
    bufIdx - The index of the buffer inside the query, such that in case the buffer searching fails, it will prompt and error indicating the buffer index.
    
    Returns:
    
    A search buffer instance according to the provide name, or null if no buffer was found.
  - validBuffer
```
private boolean validBuffer(handle h,
                            int idx)
```
    Check if the resource referenced by given handle is a valid Buffer.
    
    Parameters:
    
    h - The handle to be checked.
    
    idx - The index of this handle in a setBuffers(com.goldencode.p2j.util.handle...) call.
    
    Returns:
    
    true if the handle is valid and the referrent is a Buffer.
  - canAddBuffer
```
private boolean canAddBuffer()
```
    Check if a buffer can be added to this query.
    
    Returns:
    
    true if a buffer can be added.
  - canReposition
```
private boolean canReposition()
```
    Check if the query is opened. If is not open, an error message is displayed and an ERROR condition is raised.
    
    Returns:
    
    true if the query is not closed.
  - canGet
```
private boolean canGet()
```
    Check if the query is opened. If is not open, an error message is displayed (but no error recorded).
    
    Returns:
    
    true if the query is not closed.
  - canGetFirst
```
private boolean canGetFirst()
```
    Check if the query can be advanced via GET-FIRST.
    
    Returns:
    
    true if the query can be advanced via GET-FIRST.
  - canGetStmt
```
private boolean canGetStmt()
```
    Check if the query is opened. If is not open, an error message is displayed (but no error recorded).
    
    Returns:
    
    true if the query is not closed.
  - canLastOrPrev
```
private boolean canLastOrPrev()
```
    Check if the GET-LAST or GET-FIRST can be executed.
    
    Returns:
    
    true if not in forward-only mode.
  - assignImpl
```
private void assignImpl(P2JQuery delegate)
```
    Assign a P2JQuery instance as this container's active delegate query. Set any deferred state which has been set for the wrapper, such as scrollability and whether delegate should error out on failed first/last/unique retrievals.
    
    Parameters:
    
    delegate - New delegate query.
  - assignImpl
```
private void assignImpl(P2JQuery delegate,
                        boolean open)
```
    Assign a P2JQuery instance as this container's active delegate query. Set any deferred state which has been set for the wrapper, such as scrollability and whether delegate should error out on failed first/last/unique retrievals.
    
    Parameters:
    
    delegate - New delegate query.
    
    open - true if the query is considered to be open.
  - compoundDelegate
```
private CompoundQuery compoundDelegate()
```
    Convenience method to access the delegate query as an instance of CompoundQuery.
    
    Returns:
    
    Delegate query, cast to a CompoundQuery.
    
    Throws:
    
    java.lang.IllegalStateException - if the query delegate is not an instance of CompoundQuery.
  - preselectDelegate
```
private PreselectQuery preselectDelegate()
```
    Convenience method to access the delegate query as an instance of PreselectQuery.
    
    Returns:
    
    Delegate query, cast to a PreselectQuery.
    
    Throws:
    
    java.lang.IllegalStateException - if the query delegate is not an instance of PreselectQuery.
  - presortDelegate
```
private PresortDelegate presortDelegate()
```
    Convenience method to access the delegate query as an instance of PresortDelegate.
    
    Returns:
    
    Delegate query, cast to a PresortDelegate.
    
    Throws:
    
    java.lang.IllegalStateException - if the query delegate is not an instance of PresortDelegate.
  - randomAccessDelegate
```
private RandomAccessQuery randomAccessDelegate()
```
    Convenience method to access the delegate query as an instance of RandomAccessQuery.
    
    Returns:
    
    Delegate query, cast to a RandomAccessQuery.
    
    Throws:
    
    java.lang.IllegalStateException - if the query delegate is not an instance of RandomAccessQuery.
  - unregisterBufferRelatedQueries
```
private void unregisterBufferRelatedQueries()
```
    Unregister this wrapper from the list of related queries for all participating buffers. If any buffer is detected to be deleted (not valid or its delete operation is in progress, it is removed from the buffer list).
  - getDelegate
```
private P2JQuery getDelegate()
```
    Convenience method to access the current delegate query. TODO: this is a private method just returning a private member. Should be replaced with direct access which is much faster.
    
    Returns:
    
    Delegate query assigned to this wrapper by business logic, or the default delegate query.
  - getName
```
public java.lang.String getName()
```
    Get legacy query name.
    
    Returns:
    
    legacy query name.
  - releaseBuffers
```
public void releaseBuffers()
```
    Release the buffers. The call is forwarded to delegate query.
    
    Specified by:
    
    releaseBuffers in interface P2JQuery
  - addDynamicFilter
```
public boolean addDynamicFilter(FieldReference fr,
                                BaseDataType val,
                                java.lang.String format)
```
    Adds a new constraint term to the where predicate of this query, effectively filtering out any rows whose referenced field does not match the requested value. Semantically, the query will select rows that match
    new-where := (fr = val) AND (old-query).
    Note: The constraints are exclusive meaning that if constraints will be added for same field of same buffer, the query will return an empty result because the field cannot be at the same time equals to two different values.
    Use clearDynamicFilters() to clean all dynamically added criteria and restore the sorting order of the query to its original form.
    
    Specified by:
    
    addDynamicFilter in interface P2JQuery
    
    Parameters:
    
    fr - A reference to field used as filtering criterion. Only the rows that matches the specified value for this field will be selected. Must not be null.
    
    val - The filtering value for this constraint. Can be null or unknown, in which case the SQL null value will be assumed. In this case the predicate will look like:
    new-where := (fr IS NULL) AND (old-query)
    
    format - The format to be used when comparing values. The reason for this parameter is that for some datatype (ex: decimal) the on-screen value can be different from the database (because of rounding).
    
    Returns:
    
    true if the filtering constraint was successfully added. If the field reference is not related to the buffer(s) of this query, false is returned.
  - clearDynamicFilters
```
public void clearDynamicFilters()
```
    Clears any dynamically filters added at runtime. The query predicate will be restored to its form from generated at conversion time.
    
    Specified by:
    
    clearDynamicFilters in interface P2JQuery
  - clearDynamicSorts
```
public void clearDynamicSorts()
```
    Clears any dynamically sort criteria added at runtime. The query sort order will be restored to its form from generated at conversion time.
  - addDynamicSort
```
public void addDynamicSort(FieldReference fr,
                           boolean asc)
```
    Adds a new sorting criterion as the strongest criterion for sorting the result of this query. The other criteria remain queued, but with lower priority.
    Use clearDynamicSorts() to clean all dynamically added criteria and restore the sorting order of the query to its original form.
    
    Parameters:
    
    fr - A reference to field used as new strongest criterion. The current criteria will be kept, but with lower priority.
    
    asc - The direction of sorting for this criterion. Use true for ascending sort and false for descending sorting.
  - addDynamicSort
```
public void addDynamicSort(FieldReference[] fieldReferences,
                           boolean[] asc)
```
    Adds new sorting criteria as the most coarse set of criteria for sorting the result of this query. The other criteria remain queued, but with lower priority.
    Use clearDynamicSorts() to clean all dynamically added criteria and restore the sorting order of the query to its original form.
    
    Parameters:
    
    fieldReferences - References to fields used as new most coarse criteria. The current criteria will be kept, but with lower priority. Inside the array criteria are positioned from the most coarse to the most granular.
    
    asc - Direction of sorting for the new criteria. Use true for ascending sort and false for descending sorting. Inside the array directions are positioned from the most coarse criterion to the most granular.
  - addQueryWrapperListener
```
public void addQueryWrapperListener(QueryWrapperListener listener)
```
    Adds a listener to be notified about the query wrapper events. The events are related to the wrapper rather to the delegate. E.g. query open event is fired when the currently assigned delegate is about to be opened, and the delegate may change over time.
    
    Parameters:
    
    listener - The listener to be notified.
  - removeQueryWrapperListener
```
public void removeQueryWrapperListener(QueryWrapperListener listener)
```
    Remove a listener from being notified about the query wrapper events.
    
    Parameters:
    
    listener - The listener to be removed.
  - allowDelete
```
public boolean allowDelete(handle ref,
                           boolean explicit)
```
    Check if the resource can veto the delete or not, before attempting the HandleChain.delete() call.
    
    Specified by:
    
    allowDelete in interface Deletable
    
    Parameters:
    
    ref - The exact handle holding the reference, on which the delete is attempted.
    
    explicit - Flag indicating this is called via DELETE OBJECT from the application.
    
    Returns:
    
    false if the delete is vetoed.
  - isExplicit
```
boolean isExplicit()
```
    Test whether this is an explicit query. The implicit queries cannot be deleted in a 4GL program.
    
    Returns:
    
    true if this is a normal (explicitly) created query.
  - setImplicit
```
void setImplicit()
```
    Mark this query as implicit. By default, all queries are explicit. The implicit queries are queries managed automatically for DataSources. They are created and deleted without programmer interference.
  - notifyBeforeOpenListeners
```
void notifyBeforeOpenListeners()
```
    Notify query wrapper event listeners that the query is about to be opened.
  - setSubstitutionBuffers
```
void setSubstitutionBuffers(Buffer datasetBuffer)
```
    Instruct dynamic conversion to use the list of 'parent' buffers of datasetBuffer as substitution buffers. These are not the main buffers the query is iterating but may appear in SUBST nodes (as substitutions).
    
    Parameters:
    
    datasetBuffer - The Buffer this query is used to populate in a fill() operation. If this is not a database buffer or the buffer is a top-level buffer, no substitution buffers are added.
  - setSubstitutionBuffers
```
void setSubstitutionBuffers(Buffer... substs)
```
    Instruct dynamic conversion to add a list of substitution buffers. These are not the main buffers the query is iterating but may appear in SUBST nodes (as substitutions).
    
    Parameters:
    
    substs - A list of node that the query may use in substitution nodes.
  - notifyQueryDeleted
```
protected void notifyQueryDeleted()
```
    Notify all registered listeners the query is deleted.
  - invokeCallback
```
protected boolean invokeCallback(handle self,
                                 CallbackData cbd)
```
    Invokes a callback procedure or a callback method. The callback procedure/method must have an INPUT parameter of type DATASET or DATASET-HANDLE. The passed parameter is this DataSet object.
    
    Parameters:
    
    cbd - A CallbackData object holding the data necessary for invocation. May be null, in which case this method will silently return yes even though nothing is performed.
    
    self - The object on which the event is applied (buffer or dataset).
    
    Returns:
    
    true if no errors were encountered during execution.
  - getDataSet
```
private DataSet getDataSet()
```
    Obtains the Dataset of the first buffer of this query, if this is defined.
    
    Returns:
    
    the Dataset of the first buffer of this query, if this is defined.
  - isCallbackName
```
private static boolean isCallbackName(java.lang.String someName)
```
    Test whether a string is a valid CALLBACK name for a DataSet Query. This method is responsible for raising the 12352 error if the name specified is unknown or not OFF-END - the only supported event for dataset queries.
    
    Parameters:
    
    someName - The name to test.
    
    Returns:
    
    true only if someName is equals to "OFF-END".
  - setDelegateIndexedReposition
```
private void setDelegateIndexedReposition()
```
    Helper for making delegate query indexed reposition while checking the eligibility.

Class QueryWrapper

Nested Class Summary

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

Field Summary

Fields inherited from class com.goldencode.p2j.util.HandleChain

Fields inherited from class com.goldencode.p2j.util.HandleResource

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.util.HandleChain

Methods inherited from class com.goldencode.p2j.util.HandleResource

Methods inherited from class java.lang.Object

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

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

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

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

Methods inherited from interface com.goldencode.util.Printable

Field Detail

LOG

DEFAULT_DELEGATE

OFF_END_EVENT

OFF_END_CALL_SITE

delegate

repoListeners

scrolling

indexedReposition

errorIfNull

fetchOnReposition

browsed

openedListeners

wrapperListeners

closed

offEnd

advanced

dynamic

dynamicDelegate

admData

uniqueID

forwardOnly

prepareString

buffers

valid

qname

cleanerRegistered

skipDeletedRecordDisposition

substBuffers

externalResultListHandler

callback

relation

explicit

Constructor Detail

QueryWrapper

QueryWrapper

QueryWrapper

Method Detail

clearResults

hintFullResults

registerCleaner

createQuery

createQuery

createQuery

createQueryUnnamedPool

dynamic

_dynamic

assign

assign

assign

setScrolling

isScrolling

setIterating

isIterating

isPresort

setPresort

setIndexedReposition

isIndexedReposition

open

close

resetQuery

getTableCount

getOffEndListeners

addExternalBuffers