OSID - osid.inquiry.rules.InquiryEnablerQuery Service Interface Definition

Interface	osid.inquiry.rules.InquiryEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.inquiry.rules.InquiryEnablerQuerySession`
	`osid.inquiry.rules.InquiryEnablerSearchSession`
	`osid.inquiry.rules.InquiryEnablerSmartInquestSession`
Description	This is the query for searching inquiry enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledInquiryId
Description	Matches enablers mapped to the inquiry.
Parameters	`osid.id.Id`	`inquiryId`	the inquiry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`InquiryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledInquiryIdTerms
Description	Clears the inquiry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledInquiryQuery
Description	Tests if an `InquirytQuery` is available.
Return	`boolean`		`true` if an inquiry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledInquiryQuery
Description	Gets the query for an inquiry. Multiple retrievals produce a nested `OR` term.
Return	`osid.inquiry.InquiryQuery`		the inquiry query
Errors	UNIMPLEMENTED		`supportsRuledInquiryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledInquiryQuery()` is `true`.
Method	matchAnyRuledInquiry
Description	Matches enablers mapped to any inquiry.
Parameters	`boolean`	`match`	`true` for enablers mapped to any inquiry, `false` to match enablers mapped to no inquiries
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledInquiryTerms
Description	Clears the inquiry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInquestId
Description	Matches enablers mapped to the inquest.
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	getInquiryEnablerQueryRecord
Description	Gets the inquiry enabler query record corresponding to the given `InquiryEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`inquiryEnablerRecordType`	an inquiry enabler record type
Return	`osid.inquiry.rules.records.InquiryEnablerQueryRecord`		the inquiry enabler query record
Errors	NULL_ARGUMENT		`inquiryEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(inquiryEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.