org.osid.ontology

Interface RelevancyQuery

All Superinterfaces:

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

public interface RelevancyQuery
extends OsidRelationshipQuery

This is the query for searching relevancies. 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	clearMappedIdTerms() Clears the mapped Id terms for this query.
void	clearOntologyIdTerms() Clears the ontology Id terms for this query.
void	clearOntologyTerms() Clears the ontology terms for this query.
void	clearSubjectIdTerms() Clears the subject Id terms for this query.
void	clearSubjectTerms() Clears the subject terms for this query.
OntologyQuery	getOntologyQuery() Gets the query for a ontology.
RelevancyQueryRecord	getRelevancyQueryRecord(Type relevancytRecordType) Gets the relevancy query record corresponding to the given Relevancy record Type.
SubjectQuery	getSubjectQuery() Gets the query for an subject.
void	matchMappedId(Id id, boolean match) Sets the mapped Id for this query.
void	matchOntologyId(Id ontologyId, boolean match) Sets the ontology Id for this query.
void	matchSubjectId(Id subjectId, boolean match) Sets the subject Id for this query.
boolean	supportsOntologyQuery() Tests if a OntologyQuery is available for querying ontologies.
boolean	supportsSubjectQuery() Tests if a SubjectQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.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, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, 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

Methods inherited from interface org.osid.OsidTemporalQuery

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

Method Detail

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 an 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 supportsSubjectQuery() is true.

clearSubjectTerms

void clearSubjectTerms()

Clears the subject terms for this query.

Specified by:

clearSubjectTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

matchMappedId

void matchMappedId(Id id,
                 boolean match)

Sets the mapped Id for this query.

Parameters:

id - an Id

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

Throws:

NullArgumentException - id is null

Compliance:

mandatory - This method must be implemented.

clearMappedIdTerms

void clearMappedIdTerms()

Clears the mapped Id 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.

getRelevancyQueryRecord

RelevancyQueryRecord getRelevancyQueryRecord(Type relevancytRecordType)
                                             throws OperationFailedException

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

Parameters:

relevancytRecordType - an relevancy query record type

Returns:

the relevancy query record

Throws:

NullArgumentException - relevancyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyRecordType) is false

Compliance:

mandatory - This method must be implemented.