org.kuali.rice.kim.api.group

Class GroupQueryResults.Builder

java.lang.Object

org.kuali.rice.kim.api.group.GroupQueryResults.Builder

All Implemented Interfaces:

QueryResults<Group.Builder>, ModelBuilder

Enclosing class:

GroupQueryResults

public static class GroupQueryResults.Builder
extends Object
implements ModelBuilder, QueryResults<Group.Builder>

Method Summary

Methods

Modifier and Type	Method and Description
GroupQueryResults	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static GroupQueryResults.Builder	create()
List<Group.Builder>	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.
void	setMoreResultsAvailable(boolean moreResultsAvailable)
void	setResults(List<Group.Builder> results)
void	setTotalRowCount(Integer totalRowCount)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static GroupQueryResults.Builder create()

build

public GroupQueryResults build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null

getResults

public List<Group.Builder> getResults()

Description copied from interface: QueryResults

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

Specified by:

getResults in interface QueryResults<Group.Builder>

Returns:

the list of results

setResults

public void setResults(List<Group.Builder> results)

getTotalRowCount

public Integer getTotalRowCount()

Description copied from interface: QueryResults

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 QueryResults.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.

Specified by:

getTotalRowCount in interface QueryResults<Group.Builder>

Returns:

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

setTotalRowCount

public void setTotalRowCount(Integer totalRowCount)

isMoreResultsAvailable

public boolean isMoreResultsAvailable()

Description copied from interface: QueryResults

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 QueryResults.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.

Specified by:

isMoreResultsAvailable in interface QueryResults<Group.Builder>

Returns:

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

setMoreResultsAvailable

public void setMoreResultsAvailable(boolean moreResultsAvailable)