OSID - osid.forum.ForumQuery Service Interface Definition

Interface	osid.forum.ForumQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.forum.ForumQuery`
	`osid.forum.ForumQuerySession`
	`osid.forum.ForumSearchSession`
	`osid.forum.PostQuery`
	`osid.forum.ReplyQuery`
Description	This is the query for searching for forums. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchReplyId
Description	Sets the reply `Id` for this query to match replies assigned to forums.
Parameters	`osid.id.Id`	`replyId`	a reply `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`replyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearReplyIdTerms
Description	Clears the reply `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsReplyQuery
Description	Tests if a reply query is available.
Return	`boolean`		`true` if a reply query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getReplyQuery
Description	Gets the query for a forum.
Return	`osid.forum.ReplyQuery`		the reply query
Errors	UNIMPLEMENTED		`supportsReplyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReplyQuery()` is `true`.
Method	matchAnyReply
Description	Matches forums with any reply.
Parameters	`boolean`	`match`	`true` to match forums with any reply, `false` to match forums with no replies
Compliance	`mandatory`		This method must be implemented.
Method	clearReplyTerms
Description	Clears the reply terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPostId
Description	Sets the post `Id` for this query to match replies assigned to posts.
Parameters	`osid.id.Id`	`postId`	a post `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`postId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPostIdTerms
Description	Clears the post `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostQuery
Description	Tests if a `PostQuery` is available.
Return	`boolean`		`true` if a post query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPostQuery
Description	Gets the query for a post query. Multiple retrievals produce a nested `OR` term.
Return	`osid.forum.PostQuery`		the post query
Errors	UNIMPLEMENTED		`supportsPostQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostQuery()` is `true`.
Method	matchAnyPost
Description	Matches forums with any post.
Parameters	`boolean`	`match`	`true` to match forums with any post, `false` to match forums with no posts
Compliance	`mandatory`		This method must be implemented.
Method	clearPostTerms
Description	Clears the post terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorForumId
Description	Sets the forum `Id` for this query to match forums that have the specified forum as an ancestor.
Parameters	`osid.id.Id`	`forumId`	a forum `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`forumId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorForumIdTerms
Description	Clears the ancestor forum `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorForumQuery
Description	Tests if a `ForumQuery` is available.
Return	`boolean`		`true` if a forum query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorForumQuery
Description	Gets the query for a forum. Multiple retrievals produce a nested `OR` term.
Return	`osid.forum.ForumQuery`		the forum query
Errors	UNIMPLEMENTED		`supportsAncestorForumQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorForumQuery()` is `true`.
Method	matchAnyAncestorForum
Description	Matches forums with any ancestor.
Parameters	`boolean`	`match`	`true` to match forums with any ancestor, `false` to match root forums
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorForumTerms
Description	Clears the ancestor forum terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantForumId
Description	Sets the forum `Id` for this query to match forums that have the specified forum as a descendant.
Parameters	`osid.id.Id`	`forumId`	a forum `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`forumId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantForumIdTerms
Description	Clears the descendant forum `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantForumQuery
Description	Tests if a `ForumQuery` is available.
Return	`boolean`		`true` if a forum query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantForumQuery
Description	Gets the query for a forum. Multiple retrievals produce a nested `OR` term.
Return	`osid.forum.ForumQuery`		the forum query
Errors	UNIMPLEMENTED		`supportsDescendantForumQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantForumQuery()` is `true`.
Method	matchAnyDescendantForum
Description	Matches forums with any descendant.
Parameters	`boolean`	`match`	`true` to match forums with any descendant, `false` to match leaf forums
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantForumTerms
Description	Clears the descendant forum terms.
Compliance	`mandatory`		This method must be implemented.
Method	getForumQueryRecord
Description	Gets the forum query record corresponding to the given `Forum` record `Type`.Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`forumRecordType`	a forum record type
Return	`osid.forum.records.ForumQueryRecord`		the forum query record
Errors	NULL_ARGUMENT		`forumRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(forumRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.