OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.AuditQuery
Implementsosid.OsidGovernatorQuery
Description

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.

MethodmatchInquiryId
Description

Sets the inquiry Id for this query.

Parametersosid.id.IdinquiryIdthe inquiry Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT inquiryId is null
CompliancemandatoryThis method must be implemented.
MethodclearInquiryIdTerms
Description

Clears the inquiry Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInquiryQuery
Description

Tests if an InquiryQuery is available.

Returnboolean true if an inquiry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInquiryQuery
Description

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

Returnosid.inquiry.InquiryQuerythe inquiry query
ErrorsUNIMPLEMENTED supportsInquiryQuery() is false
ComplianceoptionalThis method must be implemented if supportsInquiryQuery() is true.
MethodmatchInquiry
Description

Matches audits with any inquiry.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearInquiryTerms
Description

Clears the inquiry query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInquestId
Description

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

Parametersosid.id.IdinquestIdthe inquest Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT inquestId is null
CompliancemandatoryThis method must be implemented.
MethodclearInquestIdTerms
Description

Clears the inquest Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInquestQuery
Description

Tests if an InquestQuery is available.

Returnboolean true if an inquest query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInquestQuery
Description

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

Returnosid.inquiry.InquestQuerythe inquest query
ErrorsUNIMPLEMENTED supportsInquestQuery() is false
ComplianceoptionalThis method must be implemented if supportsInquestQuery() is true.
MethodclearInquestTerms
Description

Clears the inquest query terms.

CompliancemandatoryThis method must be implemented.
MethodgetAuditQueryRecord
Description

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

Parametersosid.type.TypeauditRecordTypean audit record type
Returnosid.inquiry.records.AuditQueryRecordthe audit query record
ErrorsNULL_ARGUMENT auditRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auditRecordType) is false
CompliancemandatoryThis method must be implemented.