| Interface | osid.forum.PostSearchSession | ||
|---|---|---|---|
| Implements | osid.forum.PostQuerySession | ||
| Description |
This session provides methods for searching Posts may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getPostSearch | ||
| Description |
Gets a post search. | ||
| Return | osid.forum.PostSearch | the post search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostSearchOrder | ||
| Description |
Gets a post search order. The | ||
| Return | osid.forum.PostSearchOrder | the post search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostsBySearch | ||
| Description |
Gets the search results matching the given search. | ||
| Parameters | osid.forum.PostQuery | postQuery | the post query |
osid.forum.PostSearch | postSearch | the post search | |
| Return | osid.forum.PostSearchResults | the post search results | |
| Errors | NULL_ARGUMENT | postQuery or postSearch is null
| |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | postQuery or postSearch is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostQueryFromInspector | ||
| Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
| Parameters | osid.forum.PostQueryInspector | postQueryInspector | a query inspector |
| Return | osid.forum.PostQuery | the entry query | |
| Errors | NULL_ARGUMENT | postQueryInspector is null | |
| UNSUPPORTED | postQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |