org.osid.blogging

Interface BlogQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface BlogQuery
extends OsidCatalogQuery

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 Summary

Methods

Modifier and Type	Method and Description
void	clearAncestorBlogIdTerms() Clears the ancestor blog Id terms.
void	clearAncestorBlogTerms() Clears the ancestor blog terms.
void	clearDescendantBlogIdTerms() Clears the descendant blog Id terms.
void	clearDescendantBlogTerms() Clears the descendant blog terms.
void	clearEntryIdTerms() Clears the entry Id terms.
void	clearEntryTerms() Clears the entry terms.
BlogQuery	getAncestorBlogQuery() Gets the query for a blog.
BlogQueryRecord	getBlogQueryRecord(Type blogRecordType) Gets the blog query record corresponding to the given Blog record Type.
BlogQuery	getDescendantBlogQuery() Gets the query for a blog.
EntryQuery	getEntryQuery() Gets the query for an entry.
void	matchAncestorBlogId(Id blogId, boolean match) Sets the blog Id for this query to match blogs that have the specified blog as an ancestor.
void	matchAnyAncestorBlog(boolean match) Matches blogs with any ancestor.
void	matchAnyDescendantBlog(boolean match) Matches blogs with any descendant.
void	matchAnyEntry(boolean match) Matches blogs with any entries.
void	matchDescendantBlogId(Id blogId, boolean match) Sets the blog Id for this query to match blogs that have the specified blog as a descendant.
void	matchEntryId(Id entryId, boolean match) Sets the entry Id for this query.
boolean	supportsAncestorBlogQuery() Tests if a BlogQuery is available.
boolean	supportsDescendantBlogQuery() Tests if a BlogQuery is available.
boolean	supportsEntryQuery() Tests if a EntryQuery is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchEntryId

void matchEntryId(Id entryId,
                boolean match)

Sets the entry Id for this query.

Parameters:

entryId - an entry Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - entryId is null

Compliance:

mandatory - This method must be implemented.

clearEntryIdTerms

void clearEntryIdTerms()

Clears the entry Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEntryQuery

boolean supportsEntryQuery()

Tests if a EntryQuery is available.

Returns:

true if an entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEntryQuery

EntryQuery getEntryQuery()

Gets the query for an entry. Multiple retrievals produce a nested OR term.

Returns:

the entry query

Throws:

UnimplementedException - supportsEntryQuery() is false

Compliance:

optional - This method must be implemented if supportsEntryQuery() is true.

matchAnyEntry

void matchAnyEntry(boolean match)

Matches blogs with any entries.

Parameters:

match - true to match blogs with any entries, false to match blogs with no entries

Compliance:

mandatory - This method must be implemented.

clearEntryTerms

void clearEntryTerms()

Clears the entry terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorBlogId

void matchAncestorBlogId(Id blogId,
                       boolean match)

Sets the blog Id for this query to match blogs that have the specified blog as an ancestor.

Parameters:

blogId - a blog Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - blogId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorBlogIdTerms

void clearAncestorBlogIdTerms()

Clears the ancestor blog Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorBlogQuery

boolean supportsAncestorBlogQuery()

Tests if a BlogQuery is available.

Returns:

true if a blog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorBlogQuery

BlogQuery getAncestorBlogQuery()

Gets the query for a blog. Multiple retrievals produce a nested OR term.

Returns:

the blog query

Throws:

UnimplementedException - supportsAncestorBlogQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorBlogQuery() is true.

matchAnyAncestorBlog

void matchAnyAncestorBlog(boolean match)

Matches blogs with any ancestor.

Parameters:

match - true to match blogs with any ancestor, false to match root blogs

Compliance:

mandatory - This method must be implemented.

clearAncestorBlogTerms

void clearAncestorBlogTerms()

Clears the ancestor blog terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantBlogId

void matchDescendantBlogId(Id blogId,
                         boolean match)

Sets the blog Id for this query to match blogs that have the specified blog as a descendant.

Parameters:

blogId - a blog Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - blogId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantBlogIdTerms

void clearDescendantBlogIdTerms()

Clears the descendant blog Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantBlogQuery

boolean supportsDescendantBlogQuery()

Tests if a BlogQuery is available.

Returns:

true if a blog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantBlogQuery

BlogQuery getDescendantBlogQuery()

Gets the query for a blog. Multiple retrievals produce a nested OR term.

Returns:

the blog query

Throws:

UnimplementedException - supportsDescendantBlogQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantBlogQuery() is true.

matchAnyDescendantBlog

void matchAnyDescendantBlog(boolean match)

Matches blogs with any descendant.

Parameters:

match - true to match blogs with any descendant, false to match leaf blogs

Compliance:

mandatory - This method must be implemented.

clearDescendantBlogTerms

void clearDescendantBlogTerms()

Clears the descendant blog terms.

Compliance:

mandatory - This method must be implemented.

getBlogQueryRecord

BlogQueryRecord getBlogQueryRecord(Type blogRecordType)
                                   throws OperationFailedException

Gets the blog query record corresponding to the given Blog record Type. Multiple retrievals produce a nested OR term.

Parameters:

blogRecordType - a blog record type

Returns:

the blog query record

Throws:

NullArgumentException - blogRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(blogRecordType) is false

Compliance:

mandatory - This method must be implemented.