com.atlassian.crowd.plugin.rest.service.resource
Class SearchResource

java.lang.Object
  com.atlassian.crowd.plugin.rest.service.resource.AbstractResource
      com.atlassian.crowd.plugin.rest.service.resource.SearchResource

public class SearchResource
extends AbstractResource

Search resource.

Field Summary

Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

DEFAULT_SEARCH_RESULT_SIZE, MAX_RESULTS_PARAM, request, START_INDEX_PARAM, uriInfo

Constructor Summary

SearchResource(SearchController searchController)

Method Summary

javax.ws.rs.core.Response	search(String entityType, int maxResults, int startIndex, SearchRestrictionEntity searchRestriction) Searches for entities satisfying the given search restriction.
javax.ws.rs.core.Response	search(String entityType, int maxResults, int startIndex, String cqlSearchRestriction) Searches for entities satisfying the given search restriction.

Methods inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

getApplicationName, getBaseUri

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResource

public SearchResource(SearchController searchController)

Method Detail

search

public javax.ws.rs.core.Response search(String entityType,
                                        int maxResults,
                                        int startIndex,
                                        SearchRestrictionEntity searchRestriction)

Searches for entities satisfying the given search restriction.

Parameters:

entityType - type of the entity to search

maxResults - maximum number of results returned

startIndex - starting index of the results

searchRestriction - restriction entities must satisfy

search

public javax.ws.rs.core.Response search(String entityType,
                                        int maxResults,
                                        int startIndex,
                                        String cqlSearchRestriction)

Searches for entities satisfying the given search restriction.

Parameters:

entityType - type of the entity to search

maxResults - maximum number of results returned

startIndex - starting index of the results

cqlSearchRestriction - restriction entities must satisfy in the Crowd Query Language