Interface | osid.filing.FileSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getFiles | ||
Description |
Gets the file list resulting from a search. | ||
Return | osid.filing.FileList | the directory list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getFileQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.filing.FileQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getFileSearchResultsRecord | ||
Description |
Gets the file search results record corresponding to
the given file search record | ||
Parameters | osid.type.Type | fileSearchRecordType | a file search record type |
Return | osid.filing.records.FileSearchResultsRecord | the file search results record | |
Errors | NULL_ARGUMENT | fileSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(fileSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |