public interface

Query

com.atlassian.crowd.embedded.api.Query<T>

Class Overview

Represents a search query for user management. Typical queries will search for users, groups or user names, group names.

Summary

Public Methods
int getMaxResults()
The maximum number of elements to return.
Class<T> getReturnType()
The type of elements to return.
SearchRestriction getSearchRestriction()
Restrictions to apply to the query.
int getStartIndex()
The index of the first element to return.

Public Methods

public int getMaxResults ()

The maximum number of elements to return.

Returns
  • a number of elements.

public Class<T> getReturnType ()

The type of elements to return.

Returns
  • the expected type of elements to be returned by the search.

public SearchRestriction getSearchRestriction ()

Restrictions to apply to the query. Typically finding users of a given name, etc.

Returns
  • the search resctiction to apply to this query.

public int getStartIndex ()

The index of the first element to return.

Returns
  • a positive index value.