Interface | osid.filing.DirectorySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
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(); | ||
Method | searchAmongDirectories | ||
Description |
Execute this search among the given list of diectories. | ||
Parameters | osid.id.IdList | directoryIds | list of directory Ids |
Errors | NULL_ARGUMENT | directoryIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderDirectoryResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.filing.DirectorySearchOrder | directorySearchOrder | directory search order |
Errors | NULL_ARGUMENT | directorySearchOrder is null | |
UNSUPPORTED | directorySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectorySearchRecord | ||
Description |
Gets the directory search record corresponding to the
given directory search record | ||
Parameters | osid.type.Type | directorySearchRecordType | a directory search record type |
Return | osid.filing.records.DirectorySearchRecord | the directory search record | |
Errors | NULL_ARGUMENT | directorySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(directorySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |