org.osid.inquiry

Interface AuditQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, Suppliable

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.

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

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.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchInquiryId

void matchInquiryId(Id inquiryId,
                  boolean match)

Sets the inquiry Id for this query.

Parameters:

inquiryId - the inquiry Id

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

Throws:

NullArgumentException - inquiryId is null

Compliance:

mandatory - This method must be implemented.

clearInquiryIdTerms

void clearInquiryIdTerms()

Clears the inquiry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInquiryQuery

boolean supportsInquiryQuery()

Tests if an InquiryQuery is available.

Returns:

true if an inquiry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInquiryQuery

InquiryQuery getInquiryQuery()

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

Returns:

the inquiry query

Throws:

UnimplementedException - supportsInquiryQuery() is false

Compliance:

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

matchInquiry

void matchInquiry(boolean match)

Matches audits with any inquiry.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearInquiryTerms

void clearInquiryTerms()

Clears the inquiry query terms.

Compliance:

mandatory - This method must be implemented.

matchInquestId

void matchInquestId(Id inquestId,
                  boolean match)

Sets the inquest Id for this query to match audits assigned to inquests.

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.

getAuditQueryRecord

AuditQueryRecord getAuditQueryRecord(Type auditRecordType)
                                     throws OperationFailedException

Gets the audit query record corresponding to the given Audit record Type. Multiple record retrievals produce a nested OR term.

Parameters:

auditRecordType - an audit record type

Returns:

the audit query record

Throws:

NullArgumentException - auditRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditRecordType) is false

Compliance:

mandatory - This method must be implemented.