OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
filing package
Version 3.0.0
Release Candidate Preview
| Interface | osid.filing.FileSearchOrder | ||
|---|---|---|---|
| Implements | osid.filing.DirectoryEntrySearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderBySize | ||
| Description |
Specifies a preference for ordering the results by file size. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFileSearchOrderRecord | ||
| Description |
Gets the file search order record corresponding to the given file record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | fileRecordType | a file record type |
| Return | osid.filing.records.FileSearchOrderRecord | the file search order record | |
| Errors | NULL_ARGUMENT | fileRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(fileRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |