OSID - osid.control.InputQuery Service Interface Definition

Interface	osid.control.InputQuery
Implements	`osid.OsidRuleQuery`
Used By	`osid.control.InputQuerySession`
	`osid.control.InputSearchSession`
	`osid.control.InputSmartSystemSession`
	`osid.control.SystemQuery`
	`osid.control.rules.InputEnablerQuery`
Description	This is the query for searching inputs. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchDeviceId
Description	Sets the device `Id` for this query.
Parameters	`osid.id.Id`	`deviceId`	the device `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`deviceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDeviceIdTerms
Description	Clears the device `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeviceQuery
Description	Tests if a `DeviceQuery` is available.
Return	`boolean`		`true` if a device query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceQuery
Description	Gets the query for a device. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.DeviceQuery`		the device query
Errors	UNIMPLEMENTED		`supportsDeviceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeviceQuery()` is `true`.
Method	clearDeviceTerms
Description	Clears the device query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchControllerId
Description	Sets the controller `Id` for this query.
Parameters	`osid.id.Id`	`controllerId`	the controller `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`controllerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearControllerIdTerms
Description	Clears the controller `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsControllerQuery
Description	Tests if a `ControllerQuery` is available.
Return	`boolean`		`true` if a controller query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getControllerQuery
Description	Gets the query for a `ControllerQuery`. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.ControllerQuery`		the controller query
Errors	UNIMPLEMENTED		`supportsControllerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsControllerQuery()` is `true`.
Method	clearControllerTerms
Description	Clears the controller query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSystemId
Description	Sets the system `Id` for this query to match inputs assigned to systems.
Parameters	`osid.id.Id`	`systemId`	the system `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`sustemId` 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	getInputQueryRecord
Description	Gets the input query record corresponding to the given `Input` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`inputRecordType`	an input record type
Return	`osid.control.records.InputQueryRecord`		the input query record
Errors	NULL_ARGUMENT		`inputRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(inputRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.