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

Interface	osid.control.rules.DeviceEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.control.rules.DeviceEnablerQuerySession`
	`osid.control.rules.DeviceEnablerSearchSession`
	`osid.control.rules.DeviceEnablerSmartSystemSession`
Description	This is the query for searching device enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledDeviceId
Description	Matches enablers mapped to the device.
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	clearRuledDeviceIdTerms
Description	Clears the device `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledDeviceQuery
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	getRuledDeviceQuery
Description	Gets the query for a device. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.DeviceQuery`		the device query
Errors	UNIMPLEMENTED		`supportsRuledDeviceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledDeviceQuery()` is `true`.
Method	matchAnyRuledDevice
Description	Matches enablers mapped to any device.
Parameters	`boolean`	`match`	`true` for enablers mapped to any device, `false` to match enablers mapped to no devices
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledDeviceTerms
Description	Clears the device 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	getDeviceEnablerQueryRecord
Description	Gets the device enabler query record corresponding to the given `DeviceEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`deviceEnablerRecordType`	a device enabler record type
Return	`osid.control.rules.records.DeviceEnablerQueryRecord`		the device enabler query record
Errors	NULL_ARGUMENT		`deviceEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(deviceEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.