OSID - osid.forum.ForumQuerySession Service Interface Definition

Interface	osid.forum.ForumQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.forum.ForumSearchSession`
Used By	`osid.forum.ForumManager`
Used By	`osid.forum.ForumProxyManager`
Description	This session provides methods for searching `Forums`. The search query is constructed using the `ForumQuery`. The forum record `Type` also specifies the record for the forum query. Forums may have a query record indicated by their respective record types. The query record is accessed via the `ForumQuery`. The returns in this session may not be cast directly to these interfaces.
Method	canSearchForums
Description	Tests if this user can perform `Forum` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
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 `Forums` matching the given search.
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.