OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
filing package
Version 3.0.0
Release Candidate Preview
| Interface | osid.filing.DirectorySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidCatalogSearchOrder | ||
osid.filing.DirectoryEntrySearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | getDirectorySearchOrderRecord | ||
| Description |
Gets the directory search order record corresponding to the given directory record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | directoryRecordType | a directory record type |
| Return | osid.filing.records.DirectorySearchOrderRecord | the directory search order record | |
| Errors | NULL_ARGUMENT | directoryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(directoryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |