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

Modifier and Type	Method	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 .Multiple retrievals produce a nested OR term.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

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 {@code supportsEntryQuery()} is {@code 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 {@code supportsAncestorBlogQuery()} is {@code 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 {@code supportsDescendantBlogQuery()} is {@code 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.