public interface DirectorySearch extends OsidSearch
The search interface for gioverning directory searches.
An example to find directories whose name is "Library" sorted by the path name.
DirectoryQuery query = session.getDirectoryQuery(); query.addNameMatch("Library", wordStringMatchType, true); DirectorySearch search = session.getDirectorySearch(); search.orderByPath(); DirectorySearchResults results = session.getDirectoriesBySearch(query, search); DirectoryList directories = results.getDirectories();
Modifier and Type | Method and Description |
---|---|
DirectorySearchRecord |
getDirectorySearchRecord(Type directorySearchRecordType)
Gets the directory search record corresponding to the given directory
search record
Type. |
void |
orderDirectoryResults(DirectorySearchOrder directorySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongDirectories(IdList directoryIds)
Execute this search among the given list of diectories.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongDirectories(IdList directoryIds)
directoryIds
- list of directory Ids
NullArgumentException
- directoryIds
is
null
mandatory
- This method must be implemented. void orderDirectoryResults(DirectorySearchOrder directorySearchOrder)
directorySearchOrder
- directory search orderNullArgumentException
- directorySearchOrder
is null
UnsupportedException
- directorySearchOrder
is not of this servicemandatory
- This method must be implemented. DirectorySearchRecord getDirectorySearchRecord(Type directorySearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.directorySearchRecordType
- a directory search record typeNullArgumentException
-
directorySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(directorySearchRecordType)
is
false
mandatory
- This method must be implemented.