public interface BookQuery extends OsidCatalogQuery
This is the query for searching books. Each method specifies an
AND
term while multiple invocations of the same method produce a
nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorBookIdTerms()
Clears the ancestor book
Id terms. |
void |
clearAncestorBookTerms()
Clears the ancestor book terms.
|
void |
clearCommentIdTerms()
Clears the comment
Id terms. |
void |
clearCommentTerms()
Clears the comment terms.
|
void |
clearDescendantBookIdTerms()
Clears the descendant book
Id terms. |
void |
clearDescendantBookTerms()
Clears the descendant book terms.
|
BookQuery |
getAncestorBookQuery()
Gets the query for a book.
|
BookQueryRecord |
getBookQueryRecord(Type bookRecordType)
Gets the book query record corresponding to the given
Book
record Type. |
CommentQuery |
getCommentQuery()
Gets the query for a comment.
|
BookQuery |
getDescendantBookQuery()
Gets the query for a book.
|
void |
matchAncestorBookId(Id bookId,
boolean match)
Sets the book
Id for this query to match books that
have the specified book as an ancestor. |
void |
matchAnyAncestorBook(boolean match)
Matches books with any ancestor.
|
void |
matchAnyComment(boolean match)
Matches books with any comment.
|
void |
matchAnyDescendantBook(boolean match)
Matches books with any descendant.
|
void |
matchCommentId(Id commentId,
boolean match)
Sets the comment
Id for this query to match comments
assigned to books. |
void |
matchDescendantBookId(Id bookId,
boolean match)
Sets the book
Id for this query to match books that
have the specified book as a descendant. |
boolean |
supportsAncestorBookQuery()
Tests if a
BookQuery is available. |
boolean |
supportsCommentQuery()
Tests if a comment query is available.
|
boolean |
supportsDescendantBookQuery()
Tests if a
BookQuery is available. |
clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, 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 matchCommentId(Id commentId, boolean match)
Id
for this query to match comments
assigned to books.matchCommentId
in interface OsidObjectQuery
commentId
- a comment Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- commentId
is
null
mandatory
- This method must be implemented. void clearCommentIdTerms()
Id
terms.clearCommentIdTerms
in interface OsidObjectQuery
mandatory
- This method must be implemented. boolean supportsCommentQuery()
supportsCommentQuery
in interface OsidObjectQuery
true
if a comment query is available,
false
otherwisemandatory
- This method must be implemented. CommentQuery getCommentQuery()
getCommentQuery
in interface OsidObjectQuery
UnimplementedException
- supportsCommentQuery()
is false
optional
- This method must be implemented if
supportsCommentQuery()
is true.
void matchAnyComment(boolean match)
matchAnyComment
in interface OsidObjectQuery
match
- true
to match books with any comment,
false
to match books with no commentsmandatory
- This method must be implemented. void clearCommentTerms()
clearCommentTerms
in interface OsidObjectQuery
mandatory
- This method must be implemented. void matchAncestorBookId(Id bookId, boolean match)
Id
for this query to match books that
have the specified book as an ancestor.bookId
- a book Id
match
- true
for a positive match, a false
for a negative matchNullArgumentException
- bookId
is
null
mandatory
- This method must be implemented. void clearAncestorBookIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorBookQuery()
BookQuery
is available. true
if a book query is available, false
otherwisemandatory
- This method must be implemented. BookQuery getAncestorBookQuery()
OR
term.UnimplementedException
-
supportsAncestorBookQuery()
is false
optional
- This method must be implemented if
supportsAncestorBookQuery()
is true.
void matchAnyAncestorBook(boolean match)
match
- true
to match books with any ancestor,
false
to match root booksmandatory
- This method must be implemented. void clearAncestorBookTerms()
mandatory
- This method must be implemented. void matchDescendantBookId(Id bookId, boolean match)
Id
for this query to match books that
have the specified book as a descendant.bookId
- a book Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- bookId
is
null
mandatory
- This method must be implemented. void clearDescendantBookIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantBookQuery()
BookQuery
is available. true
if a book query is available, false
otherwisemandatory
- This method must be implemented. BookQuery getDescendantBookQuery()
OR
term.UnimplementedException
-
supportsDescendantBookQuery()
is false
optional
- This method must be implemented if
supportsDescendantBookQuery()
is true.
void matchAnyDescendantBook(boolean match)
match
- true
to match books with any descendant,
false
to match leaf booksmandatory
- This method must be implemented. void clearDescendantBookTerms()
mandatory
- This method must be implemented. BookQueryRecord getBookQueryRecord(Type bookRecordType) throws OperationFailedException
Book
record Type.
Multiple record retrievals produce
a nested boolean OR
term.bookRecordType
- a book record typeNullArgumentException
- bookRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(bookRecordType)
is false
mandatory
- This method must be implemented.