OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.InquestQuery
Implementsosid.OsidCatalogQuery
Description

This is the query for searching inquests. 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 to match inquests that have a related response.

Parametersosid.id.IdinquiryIdan inquiry Id
booleanmatch true if a positive match, false for 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.
MethodmatchAnyInquiry
Description

Matches inquests that have any inquiry.

Parametersbooleanmatch true to match inquests with any inquiry, false to match inquests with no inquiry
CompliancemandatoryThis method must be implemented.
MethodclearInquiryTerms
Description

Clears the inquiry query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAuditId
Description

Sets the audit Id for this query.

Parametersosid.id.IdauditIdthe audit Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT auditId is null
CompliancemandatoryThis method must be implemented.
MethodclearAuditIdTerms
Description

Clears the audit Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAuditQuery
Description

Tests if an AuditQuery is available.

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

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

Returnosid.inquiry.AuditQuerythe audit query
ErrorsUNIMPLEMENTED supportsAuditQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuditQuery() is true.
MethodmatchAnyAudit
Description

Matches inquests with any audit.

Parametersbooleanmatch true to match inquests with any audit, false to match inquests with no audit
CompliancemandatoryThis method must be implemented.
MethodclearAuditTerms
Description

Clears the audit query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchResponseId
Description

Sets the response Id for this query.

Parametersosid.id.IdresponseIdthe response Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT responseId is null
CompliancemandatoryThis method must be implemented.
MethodclearResponseIdTerms
Description

Clears the response Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResponseQuery
Description

Tests if a ResponseQuery is available.

Returnboolean true if a response query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResponseQuery
Description

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

Returnosid.inquiry.ResponseQuerythe response query
ErrorsUNIMPLEMENTED supportsResponseQuery() is false
ComplianceoptionalThis method must be implemented if supportsResponseQuery() is true.
MethodmatchAnyResponse
Description

Matches inquests with any response.

Parametersbooleanmatch true to match inquests with any response, false to match inquests with no response
CompliancemandatoryThis method must be implemented.
MethodclearResponseTerms
Description

Clears the response query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorInquestId
Description

Sets the inquest Id for this query to match inquests that have the specified inquest as an ancestor.

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

Clears the ancestor inquest Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorInquestQuery
Description

Tests if an InquestQuery is available.

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

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

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

Matches inquests with any ancestor.

Parametersbooleanmatch true to match inquests with any ancestor, false to match root inquests
CompliancemandatoryThis method must be implemented.
MethodclearAncestorInquestTerms
Description

Clears the ancestor inquest query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantInquestId
Description

Sets the inquest Id for this query to match inquests that have the specified inquest as a descendant.

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

Clears the descendant inquest Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantInquestQuery
Description

Tests if an InquestQuery is available.

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

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

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

Matches inquests with any descendant.

Parametersbooleanmatch true to match inquests with any descendant, false to match leaf inquests
CompliancemandatoryThis method must be implemented.
MethodclearDescendantInquestTerms
Description

Clears the descendant inquest query terms.

CompliancemandatoryThis method must be implemented.
MethodgetInquestQueryRecord
Description

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

Parametersosid.type.TypeinquestRecordTypean inquest record type
Returnosid.inquiry.records.InquestQueryRecordthe inquest query record
ErrorsNULL_ARGUMENT inquestRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inquestRecordType) is false
CompliancemandatoryThis method must be implemented.