org.kuali.rice.core.api.criteria

Interface QueryResults<T>

Type Parameters:

T - the type of the objects contained within the results list

All Known Implementing Classes:

CampusQueryResults, CampusQueryResults.Builder, CampusTypeQueryResults, CampusTypeQueryResults.Builder, CountryQueryResults, CountryQueryResults.Builder, CountyQueryResults, CountyQueryResults.Builder, DelegateMemberQueryResults, DelegateMemberQueryResults.Builder, EntityDefaultQueryResults, EntityDefaultQueryResults.Builder, EntityNameQueryResults, EntityNameQueryResults.Builder, EntityQueryResults, EntityQueryResults.Builder, GenericQueryResults, GenericQueryResults.Builder, GroupMemberQueryResults, GroupMemberQueryResults.Builder, GroupQueryResults, GroupQueryResults.Builder, ParameterQueryResults, ParameterQueryResults.Builder, PermissionQueryResults, PermissionQueryResults.Builder, PostalCodeQueryResults, PostalCodeQueryResults.Builder, PrincipalQueryResults, PrincipalQueryResults.Builder, ReferenceObjectBindingQueryResults, ReferenceObjectBindingQueryResults.Builder, ResponsibilityQueryResults, ResponsibilityQueryResults.Builder, RoleMemberQueryResults, RoleMemberQueryResults.Builder, RoleMembershipQueryResults, RoleMembershipQueryResults.Builder, RoleQueryResults, RoleQueryResults.Builder, RuleQueryResults, RuleQueryResults.Builder, RuleTemplateQueryResults, RuleTemplateQueryResults.Builder, StateQueryResults, StateQueryResults.Builder, TemplateQueryResults, TemplateQueryResults.Builder

public interface QueryResults<T>

Contains a collection of results from a query. This interface exists as a utility for services that want to implement it to represents results from criteria-based (or other) queries.

Also may provide information related to the count of rows returned by the query as well as whether or not the query returned all available results.

All the information in this interface is populated depending on the information requested via the QueryByCriteria.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
List<T>	getResults() Return the list of results that are contained within.
Integer	getTotalRowCount() Gets the total number of records that match the executed query.
boolean	isMoreResultsAvailable() Indicates if there are more results available for the query immediately following the last result that was returned.

Method Detail

getResults

List<T> getResults()

Return the list of results that are contained within. This list can be empty but it should never be null.

Returns:

the list of results

getTotalRowCount

Integer getTotalRowCount()

Gets the total number of records that match the executed query. Note that this number will not necessarily match the number of results returned by getResults() as the query may cut off the number of records returned by the actual query request. In these cases, the total row count represents the total number of results which would be returned by the query if there was no cap on the results returned (i.e. the equivalent of the result of a "count" query in SQL).

The total row count is optional depending on whether or not the client requested the total row count when invoking the query. The client requests this information by setting the CountFlag.INCLUDE or CountFlag.ONLY on the QueryByCriteria. It's also possible that the query is unable to produce a total row count depending on the back-end implementation, in which cases this value will also not be available.

Will never be less than 0.

Returns:

the total number of rows, or null if the total row count was not requested by the query or could not be determined

isMoreResultsAvailable

boolean isMoreResultsAvailable()

Indicates if there are more results available for the query immediately following the last result that was returned. In this case, the records returned in getResults() will not include the complete result set for the query. This could be because the query only requested a certain number of rows, or that the query couldn't return the number of rows that were requested.

It is intended that this value be used to facilitate paging or reporting in the client in cases where that is desired.

This information will only be available if the client sets a limit on the results returned. This limit is set with the maxResults field on the QueryByCriteria.

Returns:

true if there are more results available for the query, false otherwise