| Interface | osid.filing.FileSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing file searches. | ||
| Method | searchAmongFiles | ||
| Description |
Execute this search among the given list of files. | ||
| Parameters | osid.id.IdList | fileIds | list of file Ids |
| Errors | NULL_ARGUMENT | fileIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderFileResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.filing.FileSearchOrder | fileSearchOrder | file search order |
| Errors | NULL_ARGUMENT | fileSearchOrder is null | |
| UNSUPPORTED | fileSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getFileSearchRecord | ||
| Description |
Gets the file search record corresponding to the given
file search record | ||
| Parameters | osid.type.Type | fileSearchRecordType | a file search record type |
| Return | osid.filing.records.FileSearchRecord | the file search 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. | |