OSID - osid.forum.PostSearchSession Service Interface Definition

Interface	osid.forum.PostSearchSession
Implements	`osid.forum.PostQuerySession`
Used By	`osid.forum.ForumManager`
Used By	`osid.forum.ForumProxyManager`
Description	This session provides methods for searching `Posts` . The search query is constructed using the `PostQuery` . The post record `Type` also specifies the record for the post query. `getPostsByQuery()` is the basic search method and returns a list of `Post` elements. A more advanced search may be performed with `getPostsBySearch()` . It accepts a `PostSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPostsBySearch()` returns a `PostSearchResults` that can be used to access the resulting `PostList` or be used to perform a search within the result set through `PostSearch` . Posts may have a query record indicated by their respective record types. The query record is accessed via the `PostQuery` . The returns in this session may not be cast directly to these interfaces.
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 `PostSearchOrder` is supplied to a `PostSearch` to specify the ordering of results.
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
Parameters	`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 `PostSearchResults` .
Parameters	`osid.forum.PostQueryInspector`	`postQueryInspector`	a query inspector
Return	`osid.forum.PostQuery`		the entry query
Errors	NULL_ARGUMENT		`postQueryInspector` is `null`
Errors	UNSUPPORTED		`postQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.