OSID - osid.forum.ForumSearchSession Service Interface Definition

Interface	osid.forum.ForumSearchSession
Implements	`osid.forum.ForumQuerySession`
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. `getForumsByQuery()` is the basic search method and returns a list of `Forum` elements. A more advanced search may be performed with `getForumsBySearch()` . It accepts a `ForumSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getForumsBySearch()` returns a `ForumSearchResults` that can be used to access the resulting `ForumList` or be used to perform a search within the result set through `ForumSearch` . 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	getForumSearch
Description	Gets a forum search.
Return	`osid.forum.ForumSearch`		the forum search
Compliance	`mandatory`		This method must be implemented.
Method	getForumSearchOrder
Description	Gets a forum search order. The `ForumSearchOrder` is supplied to a `ForumSearch` to specify the ordering of results.
Return	`osid.forum.ForumSearchOrder`		the forum search order
Compliance	`mandatory`		This method must be implemented.
Method	getForumsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.forum.ForumQuery`	`forumQuery`	the forum query
Parameters	`osid.forum.ForumSearch`	`forumSearch`	the forum search
Return	`osid.forum.ForumSearchResults`		the forum search results
Errors	NULL_ARGUMENT		`forumQuery` or `forumSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`forumQuery` or `forumSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getForumQueryFromInspector
Description	Gets a forum query from an inspector. The inspector is available from an `ForumSearchResults` .
Parameters	`osid.forum.ForumQueryInspector`	`forumQueryInspector`	a query inspector
Return	`osid.forum.ForumQuery`		the forum query
Errors	NULL_ARGUMENT		`forumQueryInspector` is `null`
Errors	UNSUPPORTED		`forumQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.