OSID - osid.control.rules.InputEnablerQuery Service Interface Definition

Interface	osid.control.rules.InputEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.control.rules.InputEnablerQuerySession`
	`osid.control.rules.InputEnablerSearchSession`
	`osid.control.rules.InputEnablerSmartSystemSession`
Description	This is the query for searching input enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledInputId
Description	Matches enablers mapped to the input.
Parameters	`osid.id.Id`	`inputId`	the device `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`inputId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledInputIdTerms
Description	Clears the input `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledInputQuery
Description	Tests if an `InputQuery` is available.
Return	`boolean`		`true` if an input query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledInputQuery
Description	Gets the query for an input. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.InputQuery`		the input query
Errors	UNIMPLEMENTED		`supportsRuledInputQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledInputQuery()` is `true`.
Method	matchAnyRuledInput
Description	Matches enablers mapped to any input.
Parameters	`boolean`	`match`	`true` for enablers mapped to any input, `false` to match enablers mapped to no inputs
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledInputTerms
Description	Clears the input query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSystemId
Description	Matches enablers mapped to the system.
Parameters	`osid.id.Id`	`systemId`	the system `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`systemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSystemIdTerms
Description	Clears the system `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSystemQuery
Description	Tests if a `SystemQuery` is available.
Return	`boolean`		`true` if a system query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSystemQuery
Description	Gets the query for a system. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.SystemQuery`		the system query
Errors	UNIMPLEMENTED		`supportsSystemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSystemQuery()` is `true`.
Method	clearSystemTerms
Description	Clears the system query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablerQueryRecord
Description	Gets the input enabler query record corresponding to the given `InputEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`inputEnablerRecordType`	an input enabler record type
Return	`osid.control.rules.records.InputEnablerQueryRecord`		the input enabler query record
Errors	NULL_ARGUMENT		`inputEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(inputEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.