com.atlassian.crowd.console.action
Interface Searcher<T extends DirectoryEntity>
- All Known Implementing Classes:
- UserSearcherImpl
public interface Searcher<T extends DirectoryEntity>
Method Summary |
List<T> |
doSearchByApplication(long applicationId,
Boolean active,
String searchText,
int resultsStartIndex,
int resultsPerPage)
Performs a search for DirectoryEntities in the specified directory, returning a list of those that match. |
List<T> |
doSearchByDirectory(long directoryID,
Boolean active,
String searchText,
int resultsStartIndex,
int resultsPerPage)
Performs a search for DirectoryEntities in the specified directory, returning a list of those that match. |
doSearchByDirectory
List<T> doSearchByDirectory(long directoryID,
Boolean active,
String searchText,
int resultsStartIndex,
int resultsPerPage)
throws OperationFailedException,
DirectoryNotFoundException
- Performs a search for DirectoryEntities in the specified directory, returning a list of those that match.
- Parameters:
directoryID
- The directory to searchactive
- Boolean.TRUE for only active, Boolean.FALSE for disabled, null for both.searchText
- The text to search for.resultsStartIndex
- The index of the first result to return - used to avoid loading all results.resultsPerPage
- The number of results to return - used to avoid loading all results.
- Returns:
- a List of users or an empty List
- Throws:
OperationFailedException
- if the directory could not be accessed
DirectoryNotFoundException
- if the directory could not be found
doSearchByApplication
List<T> doSearchByApplication(long applicationId,
Boolean active,
String searchText,
int resultsStartIndex,
int resultsPerPage)
throws DirectoryNotFoundException,
ApplicationNotFoundException
- Performs a search for DirectoryEntities in the specified directory, returning a list of those that match.
- Parameters:
applicationId
- The application to searchactive
- Boolean.TRUE for only active, Boolean.FALSE for disabled, null for both.searchText
- The text to search for.resultsStartIndex
- The index of the first result to return - used to avoid loading all results.resultsPerPage
- The number of results to return - used to avoid loading all results.
- Returns:
- a List of users or an empty List
- Throws:
DirectoryNotFoundException
- if the directory could not be found
ApplicationNotFoundException
- of the application could not be found
Copyright © 2013 Atlassian. All Rights Reserved.