OSID - osid.commenting.CommentSearchSession Service Interface Definition

Interface	osid.commenting.CommentSearchSession
Implements	`osid.commenting.CommentQuerySession`
Used By	`osid.commenting.CommentingManager`
Used By	`osid.commenting.CommentingProxyManager`
Description	This session provides methods for searching `Comments`. The search query is constructed using the `CommentQuery`. The comment record `Type` also specifies the record for the comment query. `getCommentsByQuery()` is the basic search method and returns a list of `Comment` elements. A more advanced search may be performed with `getCommentsBySearch()`.It accepts a `CommentSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCommentsBySearch()` returns a `CommentSearchResults` that can be used to access the resulting `CommentList` or be used to perform a search within the result set through `CommentSearch`. Comments may have a query record indicated by their respective record types. The query record is accessed via the `CommentQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getCommentSearch
Description	Gets a comment search.
Return	`osid.commenting.CommentSearch`		the comment search
Compliance	`mandatory`		This method must be implemented.
Method	getCommentSearchOrder
Description	Gets a comment search order. The `CommentSearchOrder` is supplied to a `CommentSearch` to specify the ordering of results.
Return	`osid.commenting.CommentSearchOrder`		the comment search order
Compliance	`mandatory`		This method must be implemented.
Method	getCommentsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.commenting.CommentQuery`	`commentQuery`	the comment query
Parameters	`osid.commenting.CommentSearch`	`commentSearch`	the comment search
Return	`osid.commenting.CommentSearchResults`		the search results
Errors	NULL_ARGUMENT		`commentQuery` or `commentSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commentQuery` or `commentSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCommentQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `CommentSearchResults`.
Parameters	`osid.commenting.CommentQueryInspector`	`commentQueryInspector`	a comment query inspector
Return	`osid.commenting.CommentQuery`		the entry query
Errors	NULL_ARGUMENT		`commentQueryInspector` is `null`
Errors	UNSUPPORTED		`commentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.