com.atlassian.crowd.plugin.rest.service.controller
Class SearchController

java.lang.Object
  com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController
      com.atlassian.crowd.plugin.rest.service.controller.SearchController

public class SearchController
extends AbstractResourceController

Controller for the Search resource.

Field Summary

Fields inherited from class com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController

applicationManager, applicationService

Constructor Summary

SearchController(ApplicationService applicationService, ApplicationManager applicationManager, CqlQueryParser cqlQueryParser)

Method Summary

GroupEntityList	searchGroups(String applicationName, SearchRestrictionEntity searchRestrictionEntity, int maxResults, int startIndex, boolean expandGroup, URI baseUri) Searches for groups satisfying the restriction.
GroupEntityList	searchGroups(String applicationName, String cqlSearchRestriction, int maxResults, int startIndex, boolean expandGroup, URI baseUri) Searches for groups satisfying the restriction.
UserEntityList	searchUsers(String applicationName, SearchRestrictionEntity searchRestrictionEntity, int maxResults, int startIndex, boolean expandUser, URI baseUri) Searches for users satisfying the restriction.
UserEntityList	searchUsers(String applicationName, String cqlSearchRestriction, int maxResults, int startIndex, boolean expandUser, URI baseUri) Searches for users satisfying the restriction.

Methods inherited from class com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController

getApplication

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchController

public SearchController(ApplicationService applicationService,
                        ApplicationManager applicationManager,
                        CqlQueryParser cqlQueryParser)

Method Detail

searchGroups

public GroupEntityList searchGroups(String applicationName,
                                    SearchRestrictionEntity searchRestrictionEntity,
                                    int maxResults,
                                    int startIndex,
                                    boolean expandGroup,
                                    URI baseUri)

Searches for groups satisfying the restriction.

Parameters:

applicationName - name of the application.

searchRestrictionEntity - criteria for a group to be returned

maxResults - maximum number of results to return

startIndex - starting index of the result

expandGroup - set to true if the group details should be expanded.

baseUri - Base URI of the REST service

Returns:

GroupEntityList

searchUsers

public UserEntityList searchUsers(String applicationName,
                                  SearchRestrictionEntity searchRestrictionEntity,
                                  int maxResults,
                                  int startIndex,
                                  boolean expandUser,
                                  URI baseUri)

Searches for users satisfying the restriction.

Parameters:

applicationName - name of the application.

searchRestrictionEntity - criteria for a user to be returned

maxResults - maximum number of results to return

startIndex - starting index of the result

expandUser - set to true if the user details should be expanded.

baseUri - Base URI of the REST service

Returns:

UserEntityList

searchGroups

public GroupEntityList searchGroups(String applicationName,
                                    String cqlSearchRestriction,
                                    int maxResults,
                                    int startIndex,
                                    boolean expandGroup,
                                    URI baseUri)

Searches for groups satisfying the restriction.

Parameters:

applicationName - name of the application.

cqlSearchRestriction - criteria for a group to be returned in the Crowd Query Language

maxResults - maximum number of results to return

startIndex - starting index of the result

expandGroup - set to true if the group details should be expanded.

baseUri - Base URI of the REST service

Returns:

GroupEntityList

searchUsers

public UserEntityList searchUsers(String applicationName,
                                  String cqlSearchRestriction,
                                  int maxResults,
                                  int startIndex,
                                  boolean expandUser,
                                  URI baseUri)

Searches for users satisfying the restriction.

Parameters:

applicationName - name of the application.

cqlSearchRestriction - criteria for a user to be returned in the Crowd Query Language

maxResults - maximum number of results to return

startIndex - starting index of the result

expandUser - set to true if the user details should be expanded.

baseUri - Base URI of the REST service

Returns:

UserEntityList