org.osid.ontology

Interface SubjectQuery

All Superinterfaces:

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

public interface SubjectQuery
extends OsidObjectQuery, OsidFederateableQuery

This is the query for searching subjects. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAncestorSubjectIdTerms() Clears the ancestor subject Id terms for this query.
void	clearAncestorSubjectTerms() Clears the ancestor subject terms for this query.
void	clearDescendantSubjectIdTerms() Clears the descendant subject Id terms for this query.
void	clearDescendantSubjectTerms() Clears the descendant subject terms for this query.
void	clearOntologyIdTerms() Clears the ontology Id terms for this query.
void	clearOntologyTerms() Clears the ontology terms for this query.
void	clearRelevancyIdTerms() Clears the relevancy Id terms for this query.
void	clearRelevancyTerms() Clears the relevancy terms for this query.
SubjectQuery	getAncestorSubjectQuery() Gets the query for a subject.
SubjectQuery	getDescendantSubjectQuery() Gets the query for a subject.
OntologyQuery	getOntologyQuery() Gets the query for a ontology.
RelevancyQuery	getRelevancyQuery() Gets the query for a relevancy.
SubjectQueryRecord	getSubjectQueryRecord(Type subjectRecordType) Gets the subject query record corresponding to the given Subject record Type.
void	matchAncestorSubjectId(Id subjectId, boolean match) Sets the subject Id for this query to match subjects that have the specified subject as an ancestor.
void	matchAnyAncestorSubject(boolean match) Matches subjects with any ancestor.
void	matchAnyDescendantSubject(boolean match) Matches subjects with any descendant.
void	matchAnyRelevancy(boolean match) Matches ontologies that have any relevancy.
void	matchDescendantSubjectId(Id subjectId, boolean match) Sets the subject Id for this query to match subjects that have the specified subject as a descendant.
void	matchOntologyId(Id ontologyId, boolean match) Sets the ontology Id for this query.
void	matchRelevancyId(Id relevancyId, boolean match) Sets the relevancy Id for this query.
boolean	supportsAncestorSubjectQuery() Tests if a SubjectQuery is available.
boolean	supportsDescendantSubjectQuery() Tests if a SubjectQuery is available.
boolean	supportsOntologyQuery() Tests if a OntologyQuery is available for querying ontologies.
boolean	supportsRelevancyQuery() Tests if a RelevancyQuery is available.

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchAncestorSubjectId

void matchAncestorSubjectId(Id subjectId,
                          boolean match)

Sets the subject Id for this query to match subjects that have the specified subject as an ancestor.

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.

clearAncestorSubjectIdTerms

void clearAncestorSubjectIdTerms()

Clears the ancestor subject Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsAncestorSubjectQuery

boolean supportsAncestorSubjectQuery()

Tests if a SubjectQuery is available.

Returns:

true if a subject query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorSubjectQuery

SubjectQuery getAncestorSubjectQuery()

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

Returns:

the subject query

Throws:

UnimplementedException - supportsAncestorSubjectQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorSubjectQuery() is true.

matchAnyAncestorSubject

void matchAnyAncestorSubject(boolean match)

Matches subjects with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorSubjectTerms

void clearAncestorSubjectTerms()

Clears the ancestor subject terms for this query.

Compliance:

mandatory - This method must be implemented.

matchDescendantSubjectId

void matchDescendantSubjectId(Id subjectId,
                            boolean match)

Sets the subject Id for this query to match subjects that have the specified subject as a descendant.

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.

clearDescendantSubjectIdTerms

void clearDescendantSubjectIdTerms()

Clears the descendant subject Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsDescendantSubjectQuery

boolean supportsDescendantSubjectQuery()

Tests if a SubjectQuery is available.

Returns:

true if a subject query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantSubjectQuery

SubjectQuery getDescendantSubjectQuery()

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

Returns:

the subject query

Throws:

UnimplementedException - supportsDescendantSubjectQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantSubjectQuery() is true.

matchAnyDescendantSubject

void matchAnyDescendantSubject(boolean match)

Matches subjects with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantSubjectTerms

void clearDescendantSubjectTerms()

Clears the descendant subject terms for this query.

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 supportsRelevancyQuery() is 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.

matchOntologyId

void matchOntologyId(Id ontologyId,
                   boolean match)

Sets the ontology Id for this query.

Parameters:

ontologyId - a 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.

clearOntologyIdTerms

void clearOntologyIdTerms()

Clears the ontology Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsOntologyQuery

boolean supportsOntologyQuery()

Tests if a OntologyQuery is available for querying ontologies.

Returns:

true if a ontology query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOntologyQuery

OntologyQuery getOntologyQuery()

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

Returns:

the ontology query

Throws:

UnimplementedException - supportsOntologyQuery() is false

Compliance:

optional - This method must be implemented if supportsOntologyQuery() is true.

clearOntologyTerms

void clearOntologyTerms()

Clears the ontology terms for this query.

Compliance:

mandatory - This method must be implemented.

getSubjectQueryRecord

SubjectQueryRecord getSubjectQueryRecord(Type subjectRecordType)
                                         throws OperationFailedException

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

Parameters:

subjectRecordType - a subject query record type

Returns:

the subject query record

Throws:

NullArgumentException - subjectRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subjectRecordType) is false

Compliance:

mandatory - This method must be implemented.