public interface ForumQuery extends OsidCatalogQuery
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.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorForumIdTerms()
Clears the ancestor forum
Id terms. |
void |
clearAncestorForumTerms()
Clears the ancestor forum terms.
|
void |
clearDescendantForumIdTerms()
Clears the descendant forum
Id terms. |
void |
clearDescendantForumTerms()
Clears the descendant forum terms.
|
void |
clearPostIdTerms()
Clears the post
Id terms. |
void |
clearPostTerms()
Clears the post terms.
|
void |
clearReplyIdTerms()
Clears the reply
Id terms. |
void |
clearReplyTerms()
Clears the reply terms.
|
ForumQuery |
getAncestorForumQuery()
Gets the query for a forum.
|
ForumQuery |
getDescendantForumQuery()
Gets the query for a forum.
|
ForumQueryRecord |
getForumQueryRecord(Type forumRecordType)
Gets the forum query record corresponding to the given
Forum
record Type. |
PostQuery |
getPostQuery()
Gets the query for a post query.
|
ReplyQuery |
getReplyQuery()
Gets the query for a forum.
|
void |
matchAncestorForumId(Id forumId,
boolean match)
Sets the forum
Id for this query to match forums that
have the specified forum as an ancestor. |
void |
matchAnyAncestorForum(boolean match)
Matches forums with any ancestor.
|
void |
matchAnyDescendantForum(boolean match)
Matches forums with any descendant.
|
void |
matchAnyPost(boolean match)
Matches forums with any post.
|
void |
matchAnyReply(boolean match)
Matches forums with any reply.
|
void |
matchDescendantForumId(Id forumId,
boolean match)
Sets the forum
Id for this query to match forums that
have the specified forum as a descendant. |
void |
matchPostId(Id postId,
boolean match)
Sets the post
Id for this query to match replies
assigned to posts. |
void |
matchReplyId(Id replyId,
boolean match)
Sets the reply
Id for this query to match replies
assigned to forums. |
boolean |
supportsAncestorForumQuery()
Tests if a
ForumQuery is available. |
boolean |
supportsDescendantForumQuery()
Tests if a
ForumQuery is available. |
boolean |
supportsPostQuery()
Tests if a
PostQuery is available. |
boolean |
supportsReplyQuery()
Tests if a reply query 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 matchReplyId(Id replyId, boolean match)
Id
for this query to match replies
assigned to forums.replyId
- a reply Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- replyId
is
null
mandatory
- This method must be implemented. void clearReplyIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsReplyQuery()
true
if a reply query is available,
false
otherwisemandatory
- This method must be implemented. ReplyQuery getReplyQuery()
UnimplementedException
- supportsReplyQuery()
is false
optional
- This method must be implemented if
supportsReplyQuery()
is true.
void matchAnyReply(boolean match)
match
- true
to match forums with any reply,
false
to match forums with no repliesmandatory
- This method must be implemented. void clearReplyTerms()
mandatory
- This method must be implemented. void matchPostId(Id postId, boolean match)
Id
for this query to match replies
assigned to posts.postId
- a post Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- postId
is
null
mandatory
- This method must be implemented. void clearPostIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsPostQuery()
PostQuery
is available. true
if a post query is available, false
otherwisemandatory
- This method must be implemented. PostQuery getPostQuery()
OR
term.UnimplementedException
- supportsPostQuery()
is false
optional
- This method must be implemented if
supportsPostQuery()
is true.
void matchAnyPost(boolean match)
match
- true
to match forums with any post,
false
to match forums with no postsmandatory
- This method must be implemented. void clearPostTerms()
mandatory
- This method must be implemented. void matchAncestorForumId(Id forumId, boolean match)
Id
for this query to match forums that
have the specified forum as an ancestor.forumId
- a forum Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- forumId
is
null
mandatory
- This method must be implemented. void clearAncestorForumIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorForumQuery()
ForumQuery
is available. true
if a forum query is available,
false
otherwisemandatory
- This method must be implemented. ForumQuery getAncestorForumQuery()
OR
term.UnimplementedException
-
supportsAncestorForumQuery()
is false
optional
- This method must be implemented if
supportsAncestorForumQuery()
is true.
void matchAnyAncestorForum(boolean match)
match
- true
to match forums with any ancestor,
false
to match root forumsmandatory
- This method must be implemented. void clearAncestorForumTerms()
mandatory
- This method must be implemented. void matchDescendantForumId(Id forumId, boolean match)
Id
for this query to match forums that
have the specified forum as a descendant.forumId
- a forum Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- forumId
is
null
mandatory
- This method must be implemented. void clearDescendantForumIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantForumQuery()
ForumQuery
is available. true
if a forum query is available,
false
otherwisemandatory
- This method must be implemented. ForumQuery getDescendantForumQuery()
OR
term.UnimplementedException
-
supportsDescendantForumQuery()
is false
optional
- This method must be implemented if
supportsDescendantForumQuery()
is true.
void matchAnyDescendantForum(boolean match)
match
- true
to match forums with any descendant,
false
to match leaf forumsmandatory
- This method must be implemented. void clearDescendantForumTerms()
mandatory
- This method must be implemented. ForumQueryRecord getForumQueryRecord(Type forumRecordType) throws OperationFailedException
Forum
record Type.
Multiple record retrievals produce
a nested boolean OR
term.forumRecordType
- a forum record typeNullArgumentException
- forumRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(forumRecordType)
is false
mandatory
- This method must be implemented.