OSID - osid.commenting.CommentQuery Service Interface Definition

Interface	osid.commenting.CommentQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.OsidObjectQuery`
	`osid.commenting.BookQuery`
	`osid.commenting.CommentQuerySession`
	`osid.commenting.CommentSearchSession`
	`osid.commenting.CommentSmartBookSession`
Description	This is the query for searching comments. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchReferenceId
Description	Sets reference `Id`.
Parameters	`osid.id.Id`	`sourceId`	a source `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`sourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearReferenceIdTerms
Description	Clears the reference `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCommentorId
Description	Sets a resource `Id` to match a commentor.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCommentorIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentorQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommentorQuery
Description	Gets the query for a resource query. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsCommentorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentorQuery()` is `true`.
Method	clearCommentorTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCommentingAgentId
Description	Sets an agent `Id`.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCommentingAgentIdTerms
Description	Clears the agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentingAgentQuery
Description	Tests if an `AgentQuery` is available.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommentingAgentQuery
Description	Gets the query for an agent query. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsCommentingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentingAgentQuery()` is `true`.
Method	clearCommentingAgentTerms
Description	Clears the agent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchText
Description	Matches text.
Parameters	`string`	`text`	the text
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`text` is not of `stringMatchType`
	NULL_ARGUMENT		`text` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyText
Description	Matches a comment that has any text assigned.
Parameters	`boolean`	`match`	`true` to match comments with any text, `false` to match comments with no text
Compliance	`mandatory`		This method must be implemented.
Method	clearTextTerms
Description	Clears the text terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRatingId
Description	Sets a grade `Id`.
Parameters	`osid.id.Id`	`gradeId`	a grade `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRatingIdTerms
Description	Clears the rating `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRatingQuery
Description	Tests if a `GradeQuery` is available.
Return	`boolean`		`true` if a rating query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRatingQuery
Description	Gets the query for a rating query. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		the rating query
Errors	UNIMPLEMENTED		`supportsRatingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRatingQuery()` is `true`.
Method	matchAnyRating
Description	Matches books with any rating.
Parameters	`boolean`	`match`	`true` to match comments with any rating, `false` to match comments with no ratings
Compliance	`mandatory`		This method must be implemented.
Method	clearRatingTerms
Description	Clears the rating terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBookId
Description	Sets the book `Id` for this query to match comments assigned to books.
Parameters	`osid.id.Id`	`bookId`	a book `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`bookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBookIdTerms
Description	Clears the book `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBookQuery
Description	Tests if a `BookQuery` is available.
Return	`boolean`		`true` if a book query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBookQuery
Description	Gets the query for a book query. Multiple retrievals produce a nested `OR` term.
Return	`osid.commenting.BookQuery`		the book query
Errors	UNIMPLEMENTED		`supportsBookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBookQuery()` is `true`.
Method	clearBookTerms
Description	Clears the book terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCommentQueryRecord
Description	Gets the comment query record corresponding to the given `Comment` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`commentRecordType`	a comment record type
Return	`osid.commenting.records.CommentQueryRecord`		the comment query 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.