Interface RecordQueryResult


@Immutable public interface RecordQueryResult

Represents the result of a record query.

All implementations must be immutable and therefore thread-safe.

See Also: DataApi.query(String), DataApi.queryMore(RecordQueryResult)

Modifier and TypeMethodDescription
java.util.List<RecordWithSubQueryResults>getRecords()Returns the list of RecordWithSubQueryResults in this query result.
longgetTotalSize()Returns the total number of records returned by the query.
booleanisDone()If true, no additional records can be retrieved from the query result.

boolean isDone()

If true, no additional records can be retrieved from the query result. If false, one or more records remain to be retrieved. Use DataApi.queryMore(RecordQueryResult) to receive the next batch of records from this query result.

Returns: Boolean value indicating if there are more rows to be retrieved.

long getTotalSize()

Returns the total number of records returned by the query. This isn't necessarily the same number of records returned by getRecords().

Returns: The total number of records returned by the query. See Also: isDone()

@Nonnull java.util.List<RecordWithSubQueryResults> getRecords()

Returns the RecordWithSubQueryResultss in this query result. Use isDone() to determine if there are additional records to be queried with DataApi.queryMore(RecordQueryResult).

Returns: The list of RecordWithSubQueryResults in this query result.