Interface | osid.filing.DirectorySearchSession | ||
---|---|---|---|
Implements | osid.filing.DirectoryQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getDirectorySearch | ||
Description |
Gets a diectory search. | ||
Return | osid.filing.DirectorySearch | the directory search | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectorySearchOrder | ||
Description |
Gets a directory search order. The | ||
Return | osid.filing.DirectorySearchOrder | the directory search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectoriesBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.filing.DirectoryQuery | directoryQuery | the directory query |
osid.filing.DirectorySearch | directorySearch | the directory search | |
Return | osid.filing.DirectorySearchResults | the directory search results | |
Errors | NULL_ARGUMENT | directoryQuery or directorySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | directoryQuery or directorySearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectoryQueryFromInspector | ||
Description |
Gets a directory query from an inspector. The inspector
is available from an | ||
Parameters | osid.filing.DirectoryQueryInspector | directoryQueryInspector | a query inspector |
Return | osid.filing.DirectoryQuery | the directory query | |
Errors | NULL_ARGUMENT | directoryQueryInspector is null | |
UNSUPPORTED | directoryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |