OSID - osid.forum.PostSmartForumSession Service Interface Definition

Interface	osid.forum.PostSmartForumSession
Implements	`osid.OsidSession`
Used By	`osid.forum.ForumManager`
Used By	`osid.forum.ForumProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PostQuery` can be retrieved from this session and mapped to this `Forum` to create a virtual collection of `Posts`. The posts may be sequenced using the `PostSearchOrder` from this session. This `Forum` has a default query that matches any post and a default search order that specifies no sequencing. The queries may be examined using a `PostQueryInspector`. The query may be modified by converting the inspector back to a `PostQuery`.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartForums
Description	Tests if this user can manage smart forums. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart forum management is 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	getPostSearchOrder
Description	Gets a post search order.
Return	`osid.forum.PostSearchOrder`		the post search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPostQuery
Description	Applies a post query to this forum.
Parameters	`osid.forum.PostQuery`	`postQuery`	the post query
Errors	NULL_ARGUMENT		`postQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`postQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPostQuery
Description	Gets a post query inspector for this forum.
Return	`osid.forum.PostQueryInspector`		the post query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPostSequencing
Description	Applies a post search order to this forum.
Parameters	`osid.forum.PostSearchOrder`	`postSearchOrder`	the post search order
Errors	NULL_ARGUMENT		`postSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`postSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPostQueryFromInspector
Description	Gets a post query from an inspector.
Parameters	`osid.forum.PostQueryInspector`	`postQueryInspector`	a query inspector
Return	`osid.forum.PostQuery`		the post query
Errors	NULL_ARGUMENT		`postQueryInspector` is `null`
Errors	UNSUPPORTED		`postQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.