OSID - osid.commenting.RatingLookupSession Service Interface Definition

Interface	osid.commenting.RatingLookupSession
Implements	`osid.OsidSession`
Used By	`osid.commenting.CommentingManager`
Used By	`osid.commenting.CommentingProxyManager`
Description	This session defines methods for retrieving ratings. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated book view: All comment methods in this session operate, retrieve and pertain to comments defined explicitly in the current book. Using an isolated view is useful for managing comments with the `CommentAdminSession`. federated book view: All comment lookup methods in this session operate, retrieve and pertain to all comments defined in this book and any other books implicitly available in this book through book inheritence. The methods `useFederatedBookView()` and `useIsolatedBookView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getBookId
Description	Gets the `Book` `Id` associated with this session.
Return	`osid.id.Id`		the `Book Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBook
Description	Gets the `Book` associated with this session.
Return	`osid.commenting.Book`		the book
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupRatings
Description	Tests if this user can examine this book. 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 these operations.
Return	`boolean`		`false` if book reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCommentView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryCommentView
Description	A complete view of the `Comment` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedBookView
Description	Federates the view for methods in this session. A federated view will include ratings in books which are children of this book in the book hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBookView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this book only.
Compliance	`mandatory`		This method is must be implemented.
Method	getCumulativeRating
Description	Gets the cumulative rating for all the references in this book.
Return	`osid.grading.Grade`		the cumulative rating
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCumulativeRatingForReference
Description	Gets the cumulative rating for a reference.
Parameters	`osid.id.Id`	`referenceId`	the `Id` of the reference
Return	`osid.grading.Grade`		the cumulative rating
Errors	NOT_FOUND		no reference found with the given `Id`
	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCumulativeRatingForCommentor
Description	Gets the cumulative rating for a commentor.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Return	`osid.grading.Grade`		the cumulative rating
Errors	NOT_FOUND		no resource found with the given `Id`
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTopReferences
Description	Gets the top rated references in this book.
Parameters	`cardinal`	`max`	the maximum number to return
Return	`osid.id.IdList`		the top references
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReferences
Description	Gets the references with ratings equal to or higher than the given grade.
Parameters	`osid.id.Id`	`gradeId`	the `Id` of the grade
Return	`osid.grading.Grade`		the cumulative rating
Errors	NOT_FOUND		no reference found with the given `Id`
	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.