OSID Specifications
forum package
Version 3.1.0
forum package
Version 3.1.0
| Interface | osid.forum.ForumSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidCatalogSearchOrder | ||
| Used By | osid.forum.ForumSearchSession | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | getForumSearchOrderRecord | ||
| Description |
Gets the forum search order record corresponding to the given forum record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | forumRecordType | a forum record type |
| Return | osid.forum.records.ForumSearchOrderRecord | the forum search order record | |
| Errors | NULL_ARGUMENT | forumRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(forumRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |