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.
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. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledRelevancyId(Id relevancyId, boolean match)
relevancyId
- the relevancy Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- relevancyId
is
null
mandatory
- This method must be implemented. void clearRuledRelevancyIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledRelevancyQuery()
RelevancyQuery
is available. true
if a relevancy query is available,
false
otherwisemandatory
- This method must be implemented. RelevancyQuery getRuledRelevancyQuery()
OR
term.UnimplementedException
-
supportsRuledRelevancyQuery()
is false
optional
- This method must be implemented if
supportsRuledRelevancyQuery()
is true.
void matchAnyRuledRelevancy(boolean match)
match
- true
for enablers mapped to any
relevancy, false
to match enablers mapped to no
relevancymandatory
- This method must be implemented. void clearRuledRelevancyTerms()
mandatory
- This method must be implemented. void matchOntologyId(Id ontologyId, boolean match)
ontologyId
- the ontology Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- ontologyId
is
null
mandatory
- This method must be implemented. void clearOntologyIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsOntologyQuery()
OntologyQuery
is available. true
if a ontology query is available,
false
otherwisemandatory
- This method must be implemented. OntologyQuery getOntologyQuery()
OR
term.UnimplementedException
- supportsOntologyQuery()
is false
optional
- This method must be implemented if
supportsOntologyQuery()
is true.
void clearOntologyTerms()
mandatory
- This method must be implemented. RelevancyEnablerQueryRecord getRelevancyEnablerQueryRecord(Type relevancyEnablerRecordType) throws OperationFailedException
RelevancyEnabler
record Type.
Multiple
record retrievals produce a nested OR
term.relevancyEnablerRecordType
- a relevancy enabler record typeNullArgumentException
-
relevancyEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(relevancyEnablerRecordType)
is
false
mandatory
- This method must be implemented.