org.osid.inquiry.rules

Interface InquiryEnablerQuery

All Superinterfaces:

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

public interface InquiryEnablerQuery
extends OsidEnablerQuery

This is the query for searching inquiry 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	clearInquestIdTerms() Clears the inquest Id query terms.
void	clearInquestTerms() Clears the inquest query terms.
void	clearRuledAuditIdTerms() Clears the audit Id query terms.
void	clearRuledAuditTerms() Clears the audit query terms.
InquestQuery	getInquestQuery() Gets the query for an inquest.
InquiryEnablerQueryRecord	getInquiryEnablerQueryRecord(Type inquiryEnablerRecordType) Gets the inquiry enabler query record corresponding to the given InquiryEnabler record Type.
AuditQuery	getRuledAuditQuery() Gets the query for an audit.
void	matchAnyRuledAudit(boolean match) Matches enablers mapped to any audit.
void	matchInquestId(Id inquestId, boolean match) Matches enablers mapped to the inquest.
void	matchRuledAuditId(Id auditId, boolean match) Matches enablers mapped to the audit.
boolean	supportsInquestQuery() Tests if an InquestQuery is available.
boolean	supportsRuledAuditQuery() Tests if an AuditQuery 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

matchRuledAuditId

void matchRuledAuditId(Id auditId,
                     boolean match)

Matches enablers mapped to the audit.

Parameters:

auditId - the audit Id

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

Throws:

NullArgumentException - auditId is null

Compliance:

mandatory - This method must be implemented.

clearRuledAuditIdTerms

void clearRuledAuditIdTerms()

Clears the audit Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledAuditQuery

boolean supportsRuledAuditQuery()

Tests if an AuditQuery is available.

Returns:

true if an audit query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledAuditQuery

AuditQuery getRuledAuditQuery()

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

Returns:

the audit query

Throws:

UnimplementedException - supportsRuledAuditQuery() is false

Compliance:

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

matchAnyRuledAudit

void matchAnyRuledAudit(boolean match)

Matches enablers mapped to any audit.

Parameters:

match - true for enablers mapped to any audit, false to match enablers mapped to no audits

Compliance:

mandatory - This method must be implemented.

clearRuledAuditTerms

void clearRuledAuditTerms()

Clears the audit query terms.

Compliance:

mandatory - This method must be implemented.

matchInquestId

void matchInquestId(Id inquestId,
                  boolean match)

Matches enablers mapped to the inquest.

Parameters:

inquestId - the inquest Id

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

Throws:

NullArgumentException - inquestId is null

Compliance:

mandatory - This method must be implemented.

clearInquestIdTerms

void clearInquestIdTerms()

Clears the inquest Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInquestQuery

boolean supportsInquestQuery()

Tests if an InquestQuery is available.

Returns:

true if an inquest query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInquestQuery

InquestQuery getInquestQuery()

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

Returns:

the inquest query

Throws:

UnimplementedException - supportsInquestQuery() is false

Compliance:

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

clearInquestTerms

void clearInquestTerms()

Clears the inquest query terms.

Compliance:

mandatory - This method must be implemented.

getInquiryEnablerQueryRecord

InquiryEnablerQueryRecord getInquiryEnablerQueryRecord(Type inquiryEnablerRecordType)
                                                       throws OperationFailedException

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

Parameters:

inquiryEnablerRecordType - an inquiry enabler record type

Returns:

the inquiry enabler query record

Throws:

NullArgumentException - inquiryEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquiryEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.