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

All Known Subinterfaces:

FullResults

All Known Implementing Classes:

AdaptiveQuery.DynamicResults, FilteredResults, ForwardResults, PreselectQuery.TemplateResults, PresortCompoundQuery.CursorResults, Presorter.IncrementalResults, Presorter.SortedResults, ProgressiveResults, ResultsAdapter, ScrollingResults, SimpleResults
```
interface Results
```
An abstraction layer between a joinable query implementation and its results. This interface defines methods for manipulating a results set using a scrollable cursor paradigm. Each row is a virtual composite of one or more records, each represented by its primary key ID or by a reference to the DMO itself.

Field Summary

Fields
Modifier and Type Field and Description

static CentralLogger LOG
Logger

Fields
Modifier and Type	Field and Description
`static CentralLogger`	`LOG` Logger

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addRow(java.lang.Object[] row, boolean beforeRow)` Add a new row.
`void`	`cleanup()` Clean up and release any resources which this object is holding, such as open result sets.
`default boolean`	`deleteRow()` Delete the current row.
`boolean`	`first()` Move cursor to the first results row.
`java.lang.Object[]`	`get()` Get the array of objects at the current result row.
`default java.lang.Object[]`	`get(boolean forceOnlyId)` Should get the primary keys array for the objects at the current result row when implemented by subclass and forceOnlyId is true.
`java.lang.Object`	`get(int column)` Get the object at the current result row, at the specified column.
`java.lang.Long`	`getID(int column)` Get the primary key ID at the current result row, at the specified column.
`default int`	`getNumberOfLoadedRows()` Returns the number of rows which have been loaded by this object.
`int`	`getRowNumber()` Get the row number currently under the cursor.
`default boolean`	`isAutoFetch()` Is the result delegate responsible for fetching? This is usually true when using query delegates which handle the fetching process already.
`boolean`	`isFirst()` Is the cursor on the first row in the results set?
`boolean`	`isLast()` Is the cursor on the last row in the results set?
`default boolean`	`isResultSetCached()` Indicate whether the full result set is cached in this object.
`boolean`	`last()` Move cursor to the last results row.
`boolean`	`next()` Move cursor to the next results row.
`boolean`	`previous()` Move cursor to the previous results row.
`void`	`reset()` Reset the cursor to its natural starting position, before the first result row.
`boolean`	`scroll(int rows)` Scroll the cursor ahead by the specified number of rows.
`void`	`sessionClosing()` Invoked when the current Hibernate session is about to close.
`boolean`	`setRowNumber(int row)` Set the row number currently under the cursor.

- Field Detail
  - LOG
```
static final CentralLogger LOG
```
    Logger
- Method Detail
  - first
```
boolean first()
```
    Move cursor to the first results row.
    
    Returns:
    
    true if there are any results.
  - last
```
boolean last()
```
    Move cursor to the last results row.
    
    Returns:
    
    true if there are any results.
  - next
```
boolean next()
```
    Move cursor to the next results row.
    
    Returns:
    
    true if there is a result under the cursor after the move.
  - previous
```
boolean previous()
```
    Move cursor to the previous results row.
    
    Returns:
    
    true if there is a result under the cursor after the move.
  - isFirst
```
boolean isFirst()
```
    Is the cursor on the first row in the results set?
    
    Returns:
    
    true if the cursor is on the first row.
  - isLast
```
boolean isLast()
```
    Is the cursor on the last row in the results set?
    
    Returns:
    
    true if the cursor is on the first row.
  - isAutoFetch
```
default boolean isAutoFetch()
```
    Is the result delegate responsible for fetching? This is usually true when using query delegates which handle the fetching process already.
    
    Returns:
    
    true for complex results which also do the fetching.
  - get
```
java.lang.Object[] get()
```
    Get the array of objects at the current result row.
    
    Returns:
    
    Object array or null.
  - get
```
default java.lang.Object[] get(boolean forceOnlyId)
```
    Should get the primary keys array for the objects at the current result row when implemented by subclass and forceOnlyId is true. Otherwise it returns the array with the whole objects at the current result row. Default implementation also returns the array with the whole objects at the current result row.
    
    Returns:
    
    Object array or null.
  - get
```
java.lang.Object get(int column)
```
    Get the object at the current result row, at the specified column.
    
    Parameters:
    
    column - Zero-based index column of the desired object.
    
    Returns:
    
    Object at column or null.
  - getID
```
java.lang.Long getID(int column)
```
    Get the primary key ID at the current result row, at the specified column.
    
    Parameters:
    
    column - Zero-based index column of the desired ID.
    
    Returns:
    
    ID of the record or null.
  - getRowNumber
```
int getRowNumber()
```
    Get the row number currently under the cursor.
    
    Returns:
    
    Zero-based index of the current row, or -1 if the cursor is not currently on a result.
  - setRowNumber
```
boolean setRowNumber(int row)
```
    Set the row number currently under the cursor.
    
    Parameters:
    
    row - Zero-based index of the row to be set as the current row.
    
    Returns:
    
    true if there is a row at the specified row number, else false.
  - scroll
```
boolean scroll(int rows)
```
    Scroll the cursor ahead by the specified number of rows. If the number is negative, the cursor is moved backward. This may put the cursor off the end (either end) of the query's results.
    
    Parameters:
    
    rows - Number of rows to jump ahead or back.
    
    Returns:
    
    true if there is a row at the new location, else false.
  - reset
```
void reset()
```
    Reset the cursor to its natural starting position, before the first result row.
  - sessionClosing
```
void sessionClosing()
```
    Invoked when the current Hibernate session is about to close. Gives the implementation an opportunity to perform appropriate processing in response to this event.
  - cleanup
```
void cleanup()
```
    Clean up and release any resources which this object is holding, such as open result sets.
  - isResultSetCached
```
default boolean isResultSetCached()
```
    Indicate whether the full result set is cached in this object.
    
    Returns:
    
    true if all results are contained this object; false if not or if unknown (such as for a scrolling or cursored result set. Default return value is false.
  - getNumberOfLoadedRows
```
default int getNumberOfLoadedRows()
```
    Returns the number of rows which have been loaded by this object.
    
    Returns:
    
    This default implementation returns 0.
  - deleteRow
```
default boolean deleteRow()
```
    Delete the current row. This is an optional operation and this default implementation does nothing.
    
    Returns:
    
    true if the row was deleted. false if there is no row at the current position. This default implementation returns false.
  - addRow
```
default void addRow(java.lang.Object[] row,
                    boolean beforeRow)
```
    Add a new row.
    
    Parameters:
    
    row - Row data.
    
    beforeRow - true if the current position is before the row. false if the current position is on the row.

Interface Results

Field Summary

Method Summary

Field Detail

LOG

Method Detail

first

last

next

previous

isFirst

isLast

isAutoFetch

get

get

get

getID

getRowNumber

setRowNumber

scroll

reset

sessionClosing

cleanup

isResultSetCached

getNumberOfLoadedRows

deleteRow

addRow