Interface | osid.forum.ForumSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getForums | ||
Description |
Gets the forum list resulting from a search. | ||
Return | osid.forum.ForumList | the forum list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getForumQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.forum.ForumQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getForumSearchResultsRecord | ||
Description |
Gets the forum search results record corresponding to the given forum search record Type. This method is used to retrieve an object implementing the requested record. | ||
Parameters | osid.type.Type | forumSearchRecordType | a forum search record type |
Return | osid.forum.records.ForumSearchResultsRecord | the forum search results 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. |