Interface OntologyQuery

All Superinterfaces:

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

public interface OntologyQuery
extends OsidCatalogQuery

This is the query for searching ontologies. 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	clearAncestorOntologyIdTerms()	Clears the ancestor ontology Id terms for this query.
void	clearAncestorOntologyTerms()	Clears the ancestor ontology terms for this query.
void	clearDescendantOntologyIdTerms()	Clears the descendant ontology Id terms for this query.
void	clearDescendantOntologyTerms()	Clears the descendant ontology terms for this query.
void	clearRelevancyIdTerms()	Clears the relevancy Id terms for this query.
void	clearRelevancyTerms()	Clears the relevancy terms for this query.
void	clearSubjectIdTerms()	Clears the subject Id terms for this query.
void	clearSubjectTerms()	Clears the subject terms for this query.
OntologyQuery	getAncestorOntologyQuery()	Gets the query for an ontology.
OntologyQuery	getDescendantOntologyQuery()	Gets the query for an ontology.
OntologyQueryRecord	getOntologyQueryRecord(Type ontologyRecordType)	Gets the ontology query record corresponding to the given Ontology record Type .Multiple record retrievals produce a nested OR term.
RelevancyQuery	getRelevancyQuery()	Gets the query for a relevancy.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
void	matchAncestorOntologyId(Id ontologyId, boolean match)	Sets the ontology Id for this query to match ontologies that have the specified ontology as an ancestor.
void	matchAnyAncestorOntology(boolean match)	Matches ontologies with any ancestor.
void	matchAnyDescendantOntology(boolean match)	Matches ontologies with any descendant.
void	matchAnyRelevancy(boolean match)	Matches ontologies that have any relevancy.
void	matchAnySubject(boolean match)	Matches ontologies that have any subject.
void	matchDescendantOntologyId(Id ontologyId, boolean match)	Sets the ontology Id for this query to match ontologies that have the specified ontology as a descendant.
void	matchRelevancyId(Id relevancyId, boolean match)	Sets the relevancy Id for this query.
void	matchSubjectId(Id subjectId, boolean match)	Sets the subject Id for this query.
boolean	supportsAncestorOntologyQuery()	Tests if an OntologyQuery is available.
boolean	supportsDescendantOntologyQuery()	Tests if an OntologyQuery is available.
boolean	supportsRelevancyQuery()	Tests if a RelevancyQuery is available.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery 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, clearSubjectRelevancyTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, 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	clearSubjectRelevancyTerms()	Clears all subject relevancy 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.
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	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.
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	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

matchSubjectId

void matchSubjectId(Id subjectId,
 boolean match)

Sets the subject Id for this query.

Specified by:

matchSubjectId in interface OsidObjectQuery

Parameters:

subjectId - a subject Id

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

Throws:

NullArgumentException - subjectId is null

Compliance:

mandatory - This method must be implemented.

clearSubjectIdTerms

void clearSubjectIdTerms()

Clears the subject Id terms for this query.

Specified by:

clearSubjectIdTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

supportsSubjectQuery

boolean supportsSubjectQuery()

Tests if a SubjectQuery is available.

Specified by:

supportsSubjectQuery in interface OsidObjectQuery

Returns:

true if a subject query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubjectQuery

SubjectQuery getSubjectQuery()

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

Specified by:

getSubjectQuery in interface OsidObjectQuery

Returns:

the subject query

Throws:

UnimplementedException - supportsSubjectQuery() is false

Compliance:

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

matchAnySubject

void matchAnySubject(boolean match)

Matches ontologies that have any subject.

Specified by:

matchAnySubject in interface OsidObjectQuery

Parameters:

match - true to match ontologies with any subject, false to match ontologies with no subject

Compliance:

mandatory - This method must be implemented.

clearSubjectTerms

void clearSubjectTerms()

Clears the subject terms for this query.

Specified by:

clearSubjectTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

matchRelevancyId

void matchRelevancyId(Id relevancyId,
 boolean match)

Sets the relevancy Id for this query.

Parameters:

relevancyId - a relevancy Id

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

Throws:

NullArgumentException - relevancyId is null

Compliance:

mandatory - This method must be implemented.

clearRelevancyIdTerms

void clearRelevancyIdTerms()

Clears the relevancy Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsRelevancyQuery

boolean supportsRelevancyQuery()

Tests if a RelevancyQuery is available.

Returns:

true if a relevancy query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRelevancyQuery

RelevancyQuery getRelevancyQuery()

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

Returns:

the relevancy query

Throws:

UnimplementedException - supportsRelevancyQuery() is false

Compliance:

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

matchAnyRelevancy

void matchAnyRelevancy(boolean match)

Matches ontologies that have any relevancy.

Parameters:

match - true to match ontologies with any relevancy, false to match ontologies with no relevancy

Compliance:

mandatory - This method must be implemented.

clearRelevancyTerms

void clearRelevancyTerms()

Clears the relevancy terms for this query.

Compliance:

mandatory - This method must be implemented.

matchAncestorOntologyId

void matchAncestorOntologyId(Id ontologyId,
 boolean match)

Sets the ontology Id for this query to match ontologies that have the specified ontology as an ancestor.

Parameters:

ontologyId - an ontology Id

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

Throws:

NullArgumentException - ontologyId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorOntologyIdTerms

void clearAncestorOntologyIdTerms()

Clears the ancestor ontology Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsAncestorOntologyQuery

boolean supportsAncestorOntologyQuery()

Tests if an OntologyQuery is available.

Returns:

true if an ontology query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorOntologyQuery

OntologyQuery getAncestorOntologyQuery()

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

Returns:

the ontology query

Throws:

UnimplementedException - supportsAncestorOntologyQuery() is false

Compliance:

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

matchAnyAncestorOntology

void matchAnyAncestorOntology(boolean match)

Matches ontologies with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorOntologyTerms

void clearAncestorOntologyTerms()

Clears the ancestor ontology terms for this query.

Compliance:

mandatory - This method must be implemented.

matchDescendantOntologyId

void matchDescendantOntologyId(Id ontologyId,
 boolean match)

Sets the ontology Id for this query to match ontologies that have the specified ontology as a descendant.

Parameters:

ontologyId - an ontology Id

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

Throws:

NullArgumentException - ontologyId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantOntologyIdTerms

void clearDescendantOntologyIdTerms()

Clears the descendant ontology Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsDescendantOntologyQuery

boolean supportsDescendantOntologyQuery()

Tests if an OntologyQuery is available.

Returns:

true if an ontology query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantOntologyQuery

OntologyQuery getDescendantOntologyQuery()

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

Returns:

the ontology query

Throws:

UnimplementedException - supportsDescendantOntologyQuery() is false

Compliance:

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

matchAnyDescendantOntology

void matchAnyDescendantOntology(boolean match)

Matches ontologies with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantOntologyTerms

void clearDescendantOntologyTerms()

Clears the descendant ontology terms for this query.

Compliance:

mandatory - This method must be implemented.

getOntologyQueryRecord

OntologyQueryRecord getOntologyQueryRecord(Type ontologyRecordType)
                                    throws OperationFailedException

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

Parameters:

ontologyRecordType - an ontology record type

Returns:

the ontology query record

Throws:

NullArgumentException - ontologyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ontologyRecordType) is false

Compliance:

mandatory - This method must be implemented.