Interface | osid.filing.FileSearchSession | ||
---|---|---|---|
Implements | osid.filing.FileQuerySession | ||
Description |
This session provides methods for searching among files and
directories objects. The search query is constructed using a
This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getFileSearch | ||
Description |
Gets a file search. | ||
Return | osid.filing.FileSearch | the file search | |
Compliance | mandatory | This method must be implemented. | |
Method | getFileSearchOrder | ||
Description |
Gets a file search order. The | ||
Return | osid.filing.FileSearchOrder | the file search order. | |
Compliance | mandatory | This method must be implemented. | |
Method | getFilesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.filing.FileQuery | fileQuery | the file query |
osid.filing.FileSearch | fileSearch | the file search | |
Return | osid.filing.FileSearchResults | the file search results | |
Errors | NULL_ARGUMENT | fileQuery or fileSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | fileQuery or fileSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFileQueryFromInspector | ||
Description |
Gets a file query from an inspector. The inspector is
available from a | ||
Parameters | osid.filing.FileQueryInspector | fileQueryInspector | a query inspector |
Return | osid.filing.FileQuery | the file query | |
Errors | NULL_ARGUMENT | fileQueryInspector is null | |
UNSUPPORTED | fileQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |