GroupQueryResults

Name GroupQueryResults
Usage GroupService
findGroups
Type Complex

Description

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
results Results GroupList Return the list of results that are contained within. This list can
be empty but it should never be null.		     Many No  
totalRowCount Total Row Count Integer 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 {@link #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 {@link CountFlag#INCLUDE} or
{@link CountFlag#ONLY} on the {@link 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.

     One No  
moreResultsAvailable More Results Available boolean 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 {@link #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
{@link QueryByCriteria}.

 Required   One No