Interface CommentQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface CommentQuery
extends OsidRelationshipQuery

This is the query for searching comments. 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	clearBookIdTerms()	Clears the book Id terms.
void	clearBookTerms()	Clears the book terms.
void	clearCommentingAgentIdTerms()	Clears the agent Id terms.
void	clearCommentingAgentTerms()	Clears the agent terms.
void	clearCommentorIdTerms()	Clears the resource Id terms.
void	clearCommentorTerms()	Clears the resource terms.
void	clearRatingIdTerms()	Clears the rating Id terms.
void	clearRatingTerms()	Clears the rating terms.
void	clearReferenceIdTerms()	Clears the reference Id terms.
void	clearTextTerms()	Clears the text terms.
BookQuery	getBookQuery()	Gets the query for a book query.
AgentQuery	getCommentingAgentQuery()	Gets the query for an agent query.
ResourceQuery	getCommentorQuery()	Gets the query for a resource query.
CommentQueryRecord	getCommentQueryRecord(Type commentRecordType)	Gets the comment query record corresponding to the given Comment record Type .Multiple record retrievals produce a nested OR term.
GradeQuery	getRatingQuery()	Gets the query for a rating query.
void	matchAnyRating(boolean match)	Matches books with any rating.
void	matchAnyText(boolean match)	Matches a comment that has any text assigned.
void	matchBookId(Id bookId, boolean match)	Sets the book Id for this query to match comments assigned to books.
void	matchCommentingAgentId(Id agentId, boolean match)	Sets an agent Id .
void	matchCommentorId(Id resourceId, boolean match)	Sets a resource Id to match a commentor.
void	matchRatingId(Id gradeId, boolean match)	Sets a grade Id .
void	matchReferenceId(Id sourceId, boolean match)	Sets reference Id .
void	matchText(String text, Type stringMatchType, boolean match)	Matches text.
boolean	supportsBookQuery()	Tests if a BookQuery is available.
boolean	supportsCommentingAgentQuery()	Tests if an AgentQuery is available.
boolean	supportsCommentorQuery()	Tests if a ResourceQuery is available.
boolean	supportsRatingQuery()	Tests if a GradeQuery 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 OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

matchReferenceId

void matchReferenceId(Id sourceId,
 boolean match)

Sets reference Id .

Parameters:

sourceId - a source Id

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

Throws:

NullArgumentException - sourceId is null

Compliance:

mandatory - This method must be implemented.

clearReferenceIdTerms

void clearReferenceIdTerms()

Clears the reference Id terms.

Compliance:

mandatory - This method must be implemented.

matchCommentorId

void matchCommentorId(Id resourceId,
 boolean match)

Sets a resource Id to match a commentor.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearCommentorIdTerms

void clearCommentorIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCommentorQuery

boolean supportsCommentorQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCommentorQuery

ResourceQuery getCommentorQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsCommentorQuery() is false

Compliance:

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

clearCommentorTerms

void clearCommentorTerms()

Clears the resource terms.

Compliance:

mandatory - This method must be implemented.

matchCommentingAgentId

void matchCommentingAgentId(Id agentId,
 boolean match)

Sets an agent Id .

Parameters:

agentId - an agent Id

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearCommentingAgentIdTerms

void clearCommentingAgentIdTerms()

Clears the agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCommentingAgentQuery

boolean supportsCommentingAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCommentingAgentQuery

AgentQuery getCommentingAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsCommentingAgentQuery() is false

Compliance:

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

clearCommentingAgentTerms

void clearCommentingAgentTerms()

Clears the agent terms.

Compliance:

mandatory - This method must be implemented.

matchText

void matchText(String text,
 Type stringMatchType,
 boolean match)

Matches text.

Parameters:

text - the text

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - text is not of stringMatchType

NullArgumentException - text is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyText

void matchAnyText(boolean match)

Matches a comment that has any text assigned.

Parameters:

match - true to match comments with any text, false to match comments with no text

Compliance:

mandatory - This method must be implemented.

clearTextTerms

void clearTextTerms()

Clears the text terms.

Compliance:

mandatory - This method must be implemented.

matchRatingId

void matchRatingId(Id gradeId,
 boolean match)

Sets a grade Id .

Parameters:

gradeId - a grade Id

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

Throws:

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearRatingIdTerms

void clearRatingIdTerms()

Clears the rating Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRatingQuery

boolean supportsRatingQuery()

Tests if a GradeQuery is available.

Returns:

true if a rating query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRatingQuery

GradeQuery getRatingQuery()

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

Returns:

the rating query

Throws:

UnimplementedException - supportsRatingQuery() is false

Compliance:

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

matchAnyRating

void matchAnyRating(boolean match)

Matches books with any rating.

Parameters:

match - true to match comments with any rating, false to match comments with no ratings

Compliance:

mandatory - This method must be implemented.

clearRatingTerms

void clearRatingTerms()

Clears the rating terms.

Compliance:

mandatory - This method must be implemented.

matchBookId

void matchBookId(Id bookId,
 boolean match)

Sets the book Id for this query to match comments assigned to books.

Parameters:

bookId - a book Id

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

Throws:

NullArgumentException - bookId is null

Compliance:

mandatory - This method must be implemented.

clearBookIdTerms

void clearBookIdTerms()

Clears the book Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBookQuery

boolean supportsBookQuery()

Tests if a BookQuery is available.

Returns:

true if a book query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBookQuery

BookQuery getBookQuery()

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

Returns:

the book query

Throws:

UnimplementedException - supportsBookQuery() is false

Compliance:

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

clearBookTerms

void clearBookTerms()

Clears the book terms.

Compliance:

mandatory - This method must be implemented.

getCommentQueryRecord

CommentQueryRecord getCommentQueryRecord(Type commentRecordType)
                                  throws OperationFailedException

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

Parameters:

commentRecordType - a comment record type

Returns:

the comment query record

Throws:

NullArgumentException - commentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commentRecordType) is false

Compliance:

mandatory - This method must be implemented.