OSID - osid.forum.PostQuerySession Service Interface Definition

Interface	osid.forum.PostQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.forum.PostSearchSession`
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. 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	getForumId
Description	Gets the `Forum` `Id` associated with this session.
Return	`osid.id.Id`		the `Forum Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getForum
Description	Gets the `Forum` associated with this session.
Return	`osid.forum.Forum`		the forum
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedForumView
Description	Federates the view for methods in this session. A federated view will include posts in forums which are children of this forum in the forum hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedForumView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this forum only.
Compliance	`mandatory`		This method is must be implemented.
Method	canSearchPosts
Description	Tests if this user can perform `Post` 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	getPostQuery
Description	Gets a post query.
Return	`osid.forum.PostQuery`		the post query
Compliance	`mandatory`		This method must be implemented.
Method	getPostsByQuery
Description	Gets a list of `Posts` matching the given search.
Parameters	`osid.forum.PostQuery`	`postQuery`	the post query
Return	`osid.forum.PostList`		the returned `PostList`
Errors	NULL_ARGUMENT		`postQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`postQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.