public interface AuditQuery extends OsidGovernatorQuery
This is the query for searching audits. 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 |
clearInquiryIdTerms()
Clears the inquiry
Id query terms. |
void |
clearInquiryTerms()
Clears the inquiry query terms.
|
AuditQueryRecord |
getAuditQueryRecord(Type auditRecordType)
Gets the audit query record corresponding to the given
Audit
record Type. |
InquestQuery |
getInquestQuery()
Gets the query for an inquest.
|
InquiryQuery |
getInquiryQuery()
Gets the query for an inquiry.
|
void |
matchInquestId(Id inquestId,
boolean match)
Sets the inquest
Id for this query to match audits
assigned to inquests. |
void |
matchInquiry(boolean match)
Matches audits with any inquiry.
|
void |
matchInquiryId(Id inquiryId,
boolean match)
Sets the inquiry
Id for this query. |
boolean |
supportsInquestQuery()
Tests if an
InquestQuery is available. |
boolean |
supportsInquiryQuery()
Tests if an
InquiryQuery is available. |
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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchInquiryId(Id inquiryId, boolean match)
Id
for this query.inquiryId
- the inquiry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- inquiryId
is
null
mandatory
- This method must be implemented. void clearInquiryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInquiryQuery()
InquiryQuery
is available. true
if an inquiry query is available,
false
otherwisemandatory
- This method must be implemented. InquiryQuery getInquiryQuery()
OR
term.UnimplementedException
- supportsInquiryQuery()
is false
optional
- This method must be implemented if
supportsInquiryQuery()
is true.
void matchInquiry(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearInquiryTerms()
mandatory
- This method must be implemented. void matchInquestId(Id inquestId, boolean match)
Id
for this query to match audits
assigned to inquests.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. AuditQueryRecord getAuditQueryRecord(Type auditRecordType) throws OperationFailedException
Audit
record Type.
Multiple record retrievals produce
a nested OR
term.auditRecordType
- an audit record typeNullArgumentException
- auditRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(auditRecordType)
is false
mandatory
- This method must be implemented.