OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
forum package
Version 3.0.0
Release Candidate Preview
| Interface | osid.forum.ForumSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing forum searches. | ||
| Method | searchAmongForums | ||
| Description |
Execute this search among the given list of forums. | ||
| Parameters | osid.id.IdList | forumIds | list of forums |
| Errors | NULL_ARGUMENT | forumIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderForumResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.forum.ForumSearchOrder | forumsearchOrder | forum search order |
| Errors | NULL_ARGUMENT | forumsearchOrder is null | |
| UNSUPPORTED | forumsearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getForumSearchRecord | ||
| Description |
Gets the forum search record corresponding to the given
forum search record | ||
| Parameters | osid.type.Type | forumSearchRecordType | a forum search record type |
| Return | osid.forum.records.ForumSearchRecord | the forum search record | |
| Errors | NULL_ARGUMENT | forumSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(forumSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |