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.
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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchEntryId(Id entryId, boolean match)
Id
for this query.entryId
- an entry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- entryId
is
null
mandatory
- This method must be implemented. void clearEntryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsEntryQuery()
EntryQuery
is available. true
if an entry query is available,
false
otherwisemandatory
- This method must be implemented. EntryQuery getEntryQuery()
OR
term.UnimplementedException
- supportsEntryQuery()
is false
optional
- This method must be implemented if
supportsEntryQuery()
is true.
void matchAnyEntry(boolean match)
match
- true
to match blogs with any entries,
false
to match blogs with no entriesmandatory
- This method must be implemented. void clearEntryTerms()
mandatory
- This method must be implemented. void matchAncestorBlogId(Id blogId, boolean match)
Id
for this query to match blogs that
have the specified blog as an ancestor.blogId
- a blog Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- blogId
is
null
mandatory
- This method must be implemented. void clearAncestorBlogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorBlogQuery()
BlogQuery
is available. true
if a blog query is available, false
otherwisemandatory
- This method must be implemented. BlogQuery getAncestorBlogQuery()
OR
term.UnimplementedException
-
supportsAncestorBlogQuery()
is false
optional
- This method must be implemented if
supportsAncestorBlogQuery()
is true.
void matchAnyAncestorBlog(boolean match)
match
- true
to match blogs with any ancestor,
false
to match root blogsmandatory
- This method must be implemented. void clearAncestorBlogTerms()
mandatory
- This method must be implemented. void matchDescendantBlogId(Id blogId, boolean match)
Id
for this query to match blogs that
have the specified blog as a descendant.blogId
- a blog Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- blogId
is
null
mandatory
- This method must be implemented. void clearDescendantBlogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantBlogQuery()
BlogQuery
is available. true
if a blog query is available, false
otherwisemandatory
- This method must be implemented. BlogQuery getDescendantBlogQuery()
OR
term.UnimplementedException
-
supportsDescendantBlogQuery()
is false
optional
- This method must be implemented if
supportsDescendantBlogQuery()
is true.
void matchAnyDescendantBlog(boolean match)
match
- true
to match blogs with any descendant,
false
to match leaf blogsmandatory
- This method must be implemented. void clearDescendantBlogTerms()
mandatory
- This method must be implemented. BlogQueryRecord getBlogQueryRecord(Type blogRecordType) throws OperationFailedException
Blog
record Type.
Multiple retrievals produce a
nested OR
term.blogRecordType
- a blog record typeNullArgumentException
- blogRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(blogRecordType)
is false
mandatory
- This method must be implemented.