com.hcl.domino.data

Class DQLQueryResult

java.lang.Object

com.hcl.domino.data.DQLQueryResult

All Implemented Interfaces:

DbQueryResult<DQLQueryResult>

public abstract class DQLQueryResult
extends Object
implements DbQueryResult<DQLQueryResult>

Constructor Summary

Constructors

Constructor and Description
DQLQueryResult()

Method Summary

Modifier and Type	Method and Description
abstract long	getDurationInMillis() Returns the number of milliseconds it took to compute the result
abstract String	getExplainText() Returns the explain text if DBQuery.EXPLAIN was specified as query option
abstract Optional<IDTable>	getNoteIds() Returns an IDTable of documents matching the search.
abstract String	getQuery() Returns the DQL query string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hcl.domino.data.DbQueryResult

build, collectEntries, collectEntries, collectEntries, collectIds, collectIds, computeValues, computeValues, forEachDocument, getDocuments, getParentDatabase, size, sort

Constructor Detail

DQLQueryResult

public DQLQueryResult()

Method Detail

getQuery

public abstract String getQuery()

Returns the DQL query string

Returns:

DQL query

getNoteIds

public abstract Optional<IDTable> getNoteIds()

Description copied from interface: DbQueryResult

Returns an IDTable of documents matching the search.

Specified by:

getNoteIds in interface DbQueryResult<DQLQueryResult>

Returns:

an Optional describing the documents matched by the search, or an empty one if the search did not request a document collection

getExplainText

public abstract String getExplainText()

Returns the explain text if DBQuery.EXPLAIN was specified as query option

Returns:

explain text or empty string

getDurationInMillis

public abstract long getDurationInMillis()

Returns the number of milliseconds it took to compute the result

Returns:

duration