Interface | osid.forum.ForumQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching Forums may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | canSearchForums | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getForumQuery | ||
Description |
Gets a forum query. | ||
Return | osid.forum.ForumQuery | the forum query | |
Compliance | mandatory | This method must be implemented. | |
Method | getForumsByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.forum.ForumQuery | forumQuery | the forum query |
Return | osid.forum.ForumList | the returned ForumList | |
Errors | NULL_ARGUMENT | forumQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | forumQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |