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.
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. |
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 matchRuledAuditId(Id auditId, boolean match)
auditId
- the audit Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- auditId
is
null
mandatory
- This method must be implemented. void clearRuledAuditIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledAuditQuery()
AuditQuery
is available. true
if an audit query is available,
false
otherwisemandatory
- This method must be implemented. AuditQuery getRuledAuditQuery()
OR
term.UnimplementedException
-
supportsRuledAuditQuery()
is false
optional
- This method must be implemented if
supportsRuledAuditQuery()
is true.
void matchAnyRuledAudit(boolean match)
match
- true
for enablers mapped to any audit,
false
to match enablers mapped to no auditsmandatory
- This method must be implemented. void clearRuledAuditTerms()
mandatory
- This method must be implemented. void matchInquestId(Id inquestId, boolean match)
inquestId
- the inquest Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- inquestId
is
null
mandatory
- This method must be implemented. void clearInquestIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInquestQuery()
InquestQuery
is available. true
if an inquest query is available,
false
otherwisemandatory
- This method must be implemented. InquestQuery getInquestQuery()
OR
term.UnimplementedException
- supportsInquestQuery()
is false
optional
- This method must be implemented if
supportsInquestQuery()
is true.
void clearInquestTerms()
mandatory
- This method must be implemented. InquiryEnablerQueryRecord getInquiryEnablerQueryRecord(Type inquiryEnablerRecordType) throws OperationFailedException
InquiryEnabler
record Type.
Multiple
record retrievals produce a nested OR
term.inquiryEnablerRecordType
- an inquiry enabler record typeNullArgumentException
- inquiryEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inquiryEnablerRecordType)
is
false
mandatory
- This method must be implemented.