OSID - osid.inquiry.InquiryQuery Service Interface Definition

Interface	osid.inquiry.InquiryQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.inquiry.AuditQuery`
	`osid.inquiry.InquestQuery`
	`osid.inquiry.InquiryQuerySession`
	`osid.inquiry.InquirySearchSession`
	`osid.inquiry.InquirySmartInquestSession`
	`osid.inquiry.ResponseQuery`
	`osid.inquiry.rules.InquiryEnablerQuery`
Description	This is the query for searching inquiries. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchAuditorId
Description	Sets a auditor `Id` for this query.
Parameters	`osid.id.Id`	`auditorId`	a auditor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`auditorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAuditorIdTerms
Description	Clears the auditor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuditorQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a auditor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuditorQuery
Description	Gets the query for a auditor. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the auditor query
Errors	UNIMPLEMENTED		`supportsAuditorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuditorQuery()` is `true`.
Method	matchAnyAuditor
Description	Matches objects with any auditor.
Parameters	`boolean`	`match`	`true` to match objects with any auditor, `false` to match objects with no auditor
Compliance	`mandatory`		This method must be implemented.
Method	clearAuditorTerms
Description	Clears the auditor 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 `supportAuditQuery()` is `true`.
Method	clearAuditTerms
Description	Clears the audit query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchQuestion
Description	Sets the question for this query.
Parameters	`string`	`question`	the question
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`question` or `stringMatchType` is `null`
Errors	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyQuestion
Description	Matches inquiries with any question.
Parameters	`boolean`	`match`	`true` to match inquiries with a question, `false` to match inquiries with no question
Compliance	`mandatory`		This method must be implemented.
Method	clearQuestionTerms
Description	Clears the question query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequired
Description	Matches inquiries that are required.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyRequired
Description	Matches inquiries with any required flag set.
Parameters	`boolean`	`match`	`true` to match inquiries with a required flag set, `false` to match inquiries with no required flag set
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiredTerms
Description	Clears the required query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAffirmationRequired
Description	Matches inquiries that require a positive response.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAffirmationRequired
Description	Matches inquiries with any affirmation required flag set.
Parameters	`boolean`	`match`	`true` to match inquiries with an affirmation required flag set, `false` to match inquiries with no affirmation required flag set
Compliance	`mandatory`		This method must be implemented.
Method	clearAffirmationRequiredTerms
Description	Clears the affirmation required query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchNeedsOneResponse
Description	Matches inquiries that require a single response.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyNeedsOneResponse
Description	Matches inquiries with any needs one response set.
Parameters	`boolean`	`match`	`true` to match inquiries with a need one response flag set, `false` to match inquiries with no needs one response flag set
Compliance	`mandatory`		This method must be implemented.
Method	clearNeedsOneResponseTerms
Description	Clears the needs one response query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInquestId
Description	Sets the inquest `Id` for this query to match inquiries assigned to inquests.
Parameters	`osid.id.Id`	`inquestId`	the inquest `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`inquestId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInquestIdTerms
Description	Clears the inquest `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInquestQuery
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	getInquestQuery
Description	Gets the query for an inquest. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.InquestQuery`		the inquest query
Errors	UNIMPLEMENTED		`supportsInquestQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInquestQuery()` is `true`.
Method	clearInquestTerms
Description	Clears the inquest query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryQueryRecord
Description	Gets the inquiry query record corresponding to the given `Inquiry` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`inquiryRecordType`	an inquiry record type
Return	`osid.inquiry.records.InquiryQueryRecord`		the inquiry query record
Errors	NULL_ARGUMENT		`inquiryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(inquiryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.