OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
forum package
Version 3.0.0
Release Candidate Preview
| Interface | osid.forum.PostSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getPosts | ||
| Description |
Gets the post list resulting from a search. | ||
| Return | osid.forum.PostList | the post list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.forum.PostQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostSearchResultsRecord | ||
| Description |
Gets the post search results record corresponding to the given post search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | postSearchRecordType | a post search record type |
| Return | osid.forum.records.PostSearchResultsRecord | the post search results record | |
| Errors | NULL_ARGUMENT | PostSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(postSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |