OSID - osid.commenting.Comment Service Interface Definition

Interface	osid.commenting.Comment
Implements	`osid.OsidRelationship`
Description	A `Comment` represents a comment and/or rating related to a reference object in a book.
Method	getReferenceId
Description	Gets the `Id` of the referenced object to which this comment pertains.
Return	`osid.id.Id`		the reference `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCommentorId
Description	Gets the `Id` of the resource who created this comment.
Return	`osid.id.Id`		the `Resource` `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCommentor
Description	Gets the resource who created this comment.
Return	`osid.resource.Resource`		the `Resource`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCommentingAgentId
Description	Gets the `Id` of the agent who created this comment.
Return	`osid.id.Id`		the `Agent` `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCommentingAgent
Description	Gets the agent who created this comment.
Return	`osid.authentication.Agent`		the `Agent`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getText
Description	Gets the comment text.
Return	`osid.locale.DisplayText`		the comment text
Compliance	`mandatory`		This method must be implemented.
Method	hasRating
Description	Tests if this comment includes a rating.
Return	`boolean`		`true` if this comment includes a rating, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRatingId
Description	Gets the `Id` of the `Grade.`
Return	`osid.id.Id`		the `Agent` `Id`
Errors	ILLEGAL_STATE		`hasRating()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRating
Description	Gets the `Grade.`
Return	`osid.grading.Grade`		the `Grade`
Errors	ILLEGAL_STATE		`hasRating()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCommentRecord
Description	Gets the comment record corresponding to the given `Comment` record `Type.` This method is used to retrieve an object implementing the requested record. The `commentRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(commentRecordType)` is `true` .
Parameters	`osid.type.Type`	`commentRecordType`	the type of comment record to retrieve
Return	`osid.commenting.records.CommentRecord`		the comment record
Errors	NULL_ARGUMENT		`commentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(commentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.