OSID - osid.blogging.BlogQuery Service Interface Definition

Interface	osid.blogging.BlogQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching blogs. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchEntryId
Description	Sets the entry `Id` for this query.
Parameters	`osid.id.Id`	`entryId`	an entry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`entryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryIdTerms
Description	Clears the entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryQuery
Description	Tests if a `EntryQuery` is available.
Return	`boolean`		`true` if an entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryQuery
Description	Gets the query for an entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.blogging.EntryQuery`		the entry query
Errors	UNIMPLEMENTED		`supportsEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryQuery()` is `true.`
Method	matchAnyEntry
Description	Matches blogs with any entries.
Parameters	`boolean`	`match`	`true` to match blogs with any entries, `false` to match blogs with no entries
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryTerms
Description	Clears the entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorBlogId
Description	Sets the blog `Id` for this query to match blogs that have the specified blog as an ancestor.
Parameters	`osid.id.Id`	`blogId`	a blog `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`blogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBlogIdTerms
Description	Clears the ancestor blog `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorBlogQuery
Description	Tests if a `BlogQuery` is available.
Return	`boolean`		`true` if a blog query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorBlogQuery
Description	Gets the query for a blog. Multiple retrievals produce a nested `OR` term.
Return	`osid.blogging.BlogQuery`		the blog query
Errors	UNIMPLEMENTED		`supportsAncestorBlogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorBlogQuery()` is `true.`
Method	matchAnyAncestorBlog
Description	Matches blogs with any ancestor.
Parameters	`boolean`	`match`	`true` to match blogs with any ancestor, `false` to match root blogs
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBlogTerms
Description	Clears the ancestor blog terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantBlogId
Description	Sets the blog `Id` for this query to match blogs that have the specified blog as a descendant.
Parameters	`osid.id.Id`	`blogId`	a blog `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`blogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBlogIdTerms
Description	Clears the descendant blog `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantBlogQuery
Description	Tests if a `BlogQuery` is available.
Return	`boolean`		`true` if a blog query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantBlogQuery
Description	Gets the query for a blog. Multiple retrievals produce a nested `OR` term.
Return	`osid.blogging.BlogQuery`		the blog query
Errors	UNIMPLEMENTED		`supportsDescendantBlogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantBlogQuery()` is `true.`
Method	matchAnyDescendantBlog
Description	Matches blogs with any descendant.
Parameters	`boolean`	`match`	`true` to match blogs with any descendant, `false` to match leaf blogs
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBlogTerms
Description	Clears the descendant blog terms.
Compliance	`mandatory`		This method must be implemented.
Method	getBlogQueryRecord
Description	Gets the blog query record corresponding to the given `Blog` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`blogRecordType`	a blog record type
Return	`osid.blogging.records.BlogQueryRecord`		the blog query record
Errors	NULL_ARGUMENT		`blogRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(blogRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.