OSID - osid.inquiry.InquestQuery Service Interface Definition

Interface	osid.inquiry.InquestQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.inquiry.AuditQuery`
	`osid.inquiry.InquestQuery`
	`osid.inquiry.InquestQuerySession`
	`osid.inquiry.InquestSearchSession`
	`osid.inquiry.InquiryQuery`
	`osid.inquiry.ResponseQuery`
	`osid.inquiry.rules.AuditConstrainerEnablerQuery`
	`osid.inquiry.rules.AuditConstrainerQuery`
	`osid.inquiry.rules.AuditEnablerQuery`
	`osid.inquiry.rules.AuditProcessorEnablerQuery`
	show 2 more…
`osid.inquiry.rules.AuditProcessorQuery`
`osid.inquiry.rules.InquiryEnablerQuery`
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`.
Method	matchInquiryId
Description	Sets the inquiry `Id` for this query to match inquests that have a related response.
Parameters	`osid.id.Id`	`inquiryId`	an inquiry `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`inquiryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInquiryIdTerms
Description	Clears the inquiry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquiryQuery
Description	Tests if an `InquiryQuery` is available.
Return	`boolean`		`true` if an inquiry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryQuery
Description	Gets the query for an inquiry. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.InquiryQuery`		the inquiry query
Errors	UNIMPLEMENTED		`supportsInquiryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInquiryQuery()` is `true`.
Method	matchAnyInquiry
Description	Matches inquests that have any inquiry.
Parameters	`boolean`	`match`	`true` to match inquests with any inquiry, `false` to match inquests with no inquiry
Compliance	`mandatory`		This method must be implemented.
Method	clearInquiryTerms
Description	Clears the inquiry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAuditId
Description	Sets the audit `Id` for this query.
Parameters	`osid.id.Id`	`auditId`	the audit `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`auditId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAuditIdTerms
Description	Clears the audit `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditQuery
Description	Tests if an `AuditQuery` is available.
Return	`boolean`		`true` if an audit query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuditQuery
Description	Gets the query for an audit. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.AuditQuery`		the audit query
Errors	UNIMPLEMENTED		`supportsAuditQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuditQuery()` is `true`.
Method	matchAnyAudit
Description	Matches inquests with any audit.
Parameters	`boolean`	`match`	`true` to match inquests with any audit, `false` to match inquests with no audit
Compliance	`mandatory`		This method must be implemented.
Method	clearAuditTerms
Description	Clears the audit query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResponseId
Description	Sets the response `Id` for this query.
Parameters	`osid.id.Id`	`responseId`	the response `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`responseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResponseIdTerms
Description	Clears the response `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseQuery
Description	Tests if a `ResponseQuery` is available.
Return	`boolean`		`true` if a response query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResponseQuery
Description	Gets the query for a response. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.ResponseQuery`		the response query
Errors	UNIMPLEMENTED		`supportsResponseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResponseQuery()` is `true`.
Method	matchAnyResponse
Description	Matches inquests with any response.
Parameters	`boolean`	`match`	`true` to match inquests with any response, `false` to match inquests with no response
Compliance	`mandatory`		This method must be implemented.
Method	clearResponseTerms
Description	Clears the response query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorInquestId
Description	Sets the inquest `Id` for this query to match inquests that have the specified inquest as an ancestor.
Parameters	`osid.id.Id`	`inquestId`	an inquest `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`inquestId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorInquestIdTerms
Description	Clears the ancestor inquest `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorInquestQuery
Description	Tests if an `InquestQuery` is available.
Return	`boolean`		`true` if an inquest query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorInquestQuery
Description	Gets the query for an inquest. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.InquestQuery`		the inquest query
Errors	UNIMPLEMENTED		`supportsAncestorInquestQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorInquestQuery()` is `true`.
Method	matchAnyAncestorInquest
Description	Matches inquests with any ancestor.
Parameters	`boolean`	`match`	`true` to match inquests with any ancestor, `false` to match root inquests
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorInquestTerms
Description	Clears the ancestor inquest query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantInquestId
Description	Sets the inquest `Id` for this query to match inquests that have the specified inquest as a descendant.
Parameters	`osid.id.Id`	`inquestId`	an inquest `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`inquestId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantInquestIdTerms
Description	Clears the descendant inquest `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantInquestQuery
Description	Tests if an `InquestQuery` is available.
Return	`boolean`		`true` if an inquest query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantInquestQuery
Description	Gets the query for an inquest/ Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.InquestQuery`		the inquest query
Errors	UNIMPLEMENTED		`supportsDescendantInquestQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantInquestQuery()` is `true`.
Method	matchAnyDescendantInquest
Description	Matches inquests with any descendant.
Parameters	`boolean`	`match`	`true` to match inquests with any descendant, `false` to match leaf inquests
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantInquestTerms
Description	Clears the descendant inquest query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getInquestQueryRecord
Description	Gets the inquest query record corresponding to the given `Inquest` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`inquestRecordType`	an inquest record type
Return	`osid.inquiry.records.InquestQueryRecord`		the inquest query record
Errors	NULL_ARGUMENT		`inquestRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(inquestRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.