Interface BookQuery

All Superinterfaces:

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

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 .

Method Summary

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

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

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

Modifier and Type	Method	Description
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.
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	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	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	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

matchCommentId

void matchCommentId(Id commentId,
 boolean match)

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

Specified by:

matchCommentId in interface OsidObjectQuery

Parameters:

commentId - a comment Id

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

Throws:

NullArgumentException - commentId is null

Compliance:

mandatory - This method must be implemented.

clearCommentIdTerms

void clearCommentIdTerms()

Clears the comment Id terms.

Specified by:

clearCommentIdTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

supportsCommentQuery

boolean supportsCommentQuery()

Tests if a comment query is available.

Specified by:

supportsCommentQuery in interface OsidObjectQuery

Returns:

true if a comment query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCommentQuery

CommentQuery getCommentQuery()

Gets the query for a comment.

Specified by:

getCommentQuery in interface OsidObjectQuery

Returns:

the comment query

Throws:

UnimplementedException - supportsCommentQuery() is false

Compliance:

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

matchAnyComment

void matchAnyComment(boolean match)

Matches books with any comment.

Specified by:

matchAnyComment in interface OsidObjectQuery

Parameters:

match - true to match books with any comment, false to match books with no comments

Compliance:

mandatory - This method must be implemented.

clearCommentTerms

void clearCommentTerms()

Clears the comment terms.

Specified by:

clearCommentTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

matchAncestorBookId

void matchAncestorBookId(Id bookId,
 boolean match)

Sets the book Id for this query to match books that have the specified book as an ancestor.

Parameters:

bookId - a book Id

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

Throws:

NullArgumentException - bookId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorBookIdTerms

void clearAncestorBookIdTerms()

Clears the ancestor book Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorBookQuery

boolean supportsAncestorBookQuery()

Tests if a BookQuery is available.

Returns:

true if a book query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorBookQuery

BookQuery getAncestorBookQuery()

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

Returns:

the book query

Throws:

UnimplementedException - supportsAncestorBookQuery() is false

Compliance:

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

matchAnyAncestorBook

void matchAnyAncestorBook(boolean match)

Matches books with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorBookTerms

void clearAncestorBookTerms()

Clears the ancestor book terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantBookId

void matchDescendantBookId(Id bookId,
 boolean match)

Sets the book Id for this query to match books that have the specified book as a descendant.

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.

clearDescendantBookIdTerms

void clearDescendantBookIdTerms()

Clears the descendant book Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantBookQuery

boolean supportsDescendantBookQuery()

Tests if a BookQuery is available.

Returns:

true if a book query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantBookQuery

BookQuery getDescendantBookQuery()

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

Returns:

the book query

Throws:

UnimplementedException - supportsDescendantBookQuery() is false

Compliance:

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

matchAnyDescendantBook

void matchAnyDescendantBook(boolean match)

Matches books with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantBookTerms

void clearDescendantBookTerms()

Clears the descendant book terms.

Compliance:

mandatory - This method must be implemented.

getBookQueryRecord

BookQueryRecord getBookQueryRecord(Type bookRecordType)
                            throws OperationFailedException

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

Parameters:

bookRecordType - a book record type

Returns:

the book query record

Throws:

NullArgumentException - bookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bookRecordType) is false

Compliance:

mandatory - This method must be implemented.