Interface ForumQuery

All Superinterfaces:

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

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 .

Method Summary

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

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

matchReplyId

void matchReplyId(Id replyId,
 boolean match)

Sets the reply Id for this query to match replies assigned to forums.

Parameters:

replyId - a reply Id

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

Throws:

NullArgumentException - replyId is null

Compliance:

mandatory - This method must be implemented.

clearReplyIdTerms

void clearReplyIdTerms()

Clears the reply Id terms.

Compliance:

mandatory - This method must be implemented.

supportsReplyQuery

boolean supportsReplyQuery()

Tests if a reply query is available.

Returns:

true if a reply query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getReplyQuery

ReplyQuery getReplyQuery()

Gets the query for a forum.

Returns:

the reply query

Throws:

UnimplementedException - supportsReplyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsReplyQuery()} is {@code true} .

matchAnyReply

void matchAnyReply(boolean match)

Matches forums with any reply.

Parameters:

match - true to match forums with any reply, false to match forums with no replies

Compliance:

mandatory - This method must be implemented.

clearReplyTerms

void clearReplyTerms()

Clears the reply terms.

Compliance:

mandatory - This method must be implemented.

matchPostId

void matchPostId(Id postId,
 boolean match)

Sets the post Id for this query to match replies assigned to posts.

Parameters:

postId - a post Id

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

Throws:

NullArgumentException - postId is null

Compliance:

mandatory - This method must be implemented.

clearPostIdTerms

void clearPostIdTerms()

Clears the post Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPostQuery

boolean supportsPostQuery()

Tests if a PostQuery is available.

Returns:

true if a post query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPostQuery

PostQuery getPostQuery()

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

Returns:

the post query

Throws:

UnimplementedException - supportsPostQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPostQuery()} is {@code true} .

matchAnyPost

void matchAnyPost(boolean match)

Matches forums with any post.

Parameters:

match - true to match forums with any post, false to match forums with no posts

Compliance:

mandatory - This method must be implemented.

clearPostTerms

void clearPostTerms()

Clears the post terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorForumId

void matchAncestorForumId(Id forumId,
 boolean match)

Sets the forum Id for this query to match forums that have the specified forum as an ancestor.

Parameters:

forumId - a forum Id

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

Throws:

NullArgumentException - forumId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorForumIdTerms

void clearAncestorForumIdTerms()

Clears the ancestor forum Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorForumQuery

boolean supportsAncestorForumQuery()

Tests if a ForumQuery is available.

Returns:

true if a forum query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorForumQuery

ForumQuery getAncestorForumQuery()

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

Returns:

the forum query

Throws:

UnimplementedException - supportsAncestorForumQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAncestorForumQuery()} is {@code true} .

matchAnyAncestorForum

void matchAnyAncestorForum(boolean match)

Matches forums with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorForumTerms

void clearAncestorForumTerms()

Clears the ancestor forum terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantForumId

void matchDescendantForumId(Id forumId,
 boolean match)

Sets the forum Id for this query to match forums that have the specified forum as a descendant.

Parameters:

forumId - a forum Id

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

Throws:

NullArgumentException - forumId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantForumIdTerms

void clearDescendantForumIdTerms()

Clears the descendant forum Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantForumQuery

boolean supportsDescendantForumQuery()

Tests if a ForumQuery is available.

Returns:

true if a forum query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantForumQuery

ForumQuery getDescendantForumQuery()

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

Returns:

the forum query

Throws:

UnimplementedException - supportsDescendantForumQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDescendantForumQuery()} is {@code true} .

matchAnyDescendantForum

void matchAnyDescendantForum(boolean match)

Matches forums with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantForumTerms

void clearDescendantForumTerms()

Clears the descendant forum terms.

Compliance:

mandatory - This method must be implemented.

getForumQueryRecord

ForumQueryRecord getForumQueryRecord(Type forumRecordType)
                              throws OperationFailedException

Gets the forum query record corresponding to the given Forum record Type .Multiple record retrievals produce a nested boolean OR term.

Parameters:

forumRecordType - a forum record type

Returns:

the forum query record

Throws:

NullArgumentException - forumRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(forumRecordType) is false

Compliance:

mandatory - This method must be implemented.