org.osid.ontology.rules

Interface RelevancyEnablerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

public interface RelevancyEnablerQuery
extends OsidEnablerQuery

This is the query for searching relevancy enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearOntologyIdTerms() Clears the ontology Id query terms.
void	clearOntologyTerms() Clears the ontology query terms.
void	clearRuledRelevancyIdTerms() Clears the relevancy Id query terms.
void	clearRuledRelevancyTerms() Clears the relevancy query terms.
OntologyQuery	getOntologyQuery() Gets the query for a ontology.
RelevancyEnablerQueryRecord	getRelevancyEnablerQueryRecord(Type relevancyEnablerRecordType) Gets the relevancy enabler query record corresponding to the given RelevancyEnabler record Type.
RelevancyQuery	getRuledRelevancyQuery() Gets the query for a relevancy.
void	matchAnyRuledRelevancy(boolean match) Matches enablers mapped to any relevancy.
void	matchOntologyId(Id ontologyId, boolean match) Matches enablers mapped to the ontology.
void	matchRuledRelevancyId(Id relevancyId, boolean match) Matches enablers mapped to the relevancy.
boolean	supportsOntologyQuery() Tests if a OntologyQuery is available.
boolean	supportsRuledRelevancyQuery() Tests if a RelevancyQuery is available.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

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

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidTemporalQuery

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

Method Detail

matchRuledRelevancyId

void matchRuledRelevancyId(Id relevancyId,
                         boolean match)

Matches enablers mapped to the relevancy.

Parameters:

relevancyId - the 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.

clearRuledRelevancyIdTerms

void clearRuledRelevancyIdTerms()

Clears the relevancy Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledRelevancyQuery

boolean supportsRuledRelevancyQuery()

Tests if a RelevancyQuery is available.

Returns:

true if a relevancy query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledRelevancyQuery

RelevancyQuery getRuledRelevancyQuery()

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

Returns:

the relevancy query

Throws:

UnimplementedException - supportsRuledRelevancyQuery() is false

Compliance:

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

matchAnyRuledRelevancy

void matchAnyRuledRelevancy(boolean match)

Matches enablers mapped to any relevancy.

Parameters:

match - true for enablers mapped to any relevancy, false to match enablers mapped to no relevancy

Compliance:

mandatory - This method must be implemented.

clearRuledRelevancyTerms

void clearRuledRelevancyTerms()

Clears the relevancy query terms.

Compliance:

mandatory - This method must be implemented.

matchOntologyId

void matchOntologyId(Id ontologyId,
                   boolean match)

Matches enablers mapped to the ontology.

Parameters:

ontologyId - the 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 query terms.

Compliance:

mandatory - This method must be implemented.

supportsOntologyQuery

boolean supportsOntologyQuery()

Tests if a OntologyQuery is available.

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 query terms.

Compliance:

mandatory - This method must be implemented.

getRelevancyEnablerQueryRecord

RelevancyEnablerQueryRecord getRelevancyEnablerQueryRecord(Type relevancyEnablerRecordType)
                                                           throws OperationFailedException

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

Parameters:

relevancyEnablerRecordType - a relevancy enabler record type

Returns:

the relevancy enabler query record

Throws:

NullArgumentException - relevancyEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.