OSID - osid.control.SystemQuery Service Interface Definition

Interface	osid.control.SystemQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching systems. 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 to match systems that have a related device.
Parameters	`osid.id.Id`	`deviceId`	a device `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for 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	matchAnyDevice
Description	Matches systems that have any device.
Parameters	`boolean`	`match`	`true` to match systems with any device, `false` to match systems with no device
Compliance	`mandatory`		This method must be implemented.
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 controller. 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	matchAnyController
Description	Matches systems with any controller.
Parameters	`boolean`	`match`	`true` to match systems with any controller, `false` to match systems with no controller
Compliance	`mandatory`		This method must be implemented.
Method	clearControllerTerms
Description	Clears the controller query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInputId
Description	Sets the input `Id` for this query.
Parameters	`osid.id.Id`	`inputId`	the input `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	clearInputIdTerms
Description	Clears the input `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInputQuery
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	getInputQuery
Description	Gets the query for an input. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.InputQuery`		the input query
Errors	UNIMPLEMENTED		`supportsInputQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInputQuery()` is `true.`
Method	matchAnyInput
Description	Matches systems with any input.
Parameters	`boolean`	`match`	`true` to match systems with any input, `false` to match systems with no inputs
Compliance	`mandatory`		This method must be implemented.
Method	clearInputTerms
Description	Clears the input query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSettingId
Description	Sets the setting `Id` for this query.
Parameters	`osid.id.Id`	`settingId`	the setting `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`settingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSettingIdTerms
Description	Clears the setting `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSettingQuery
Description	Tests if a `SettingQuery` is available.
Return	`boolean`		`true` if a setting query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSettingQuery
Description	Gets the query for a setting. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.SettingQuery`		the setting query
Errors	UNIMPLEMENTED		`supportsSettingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSettingQuery()` is `true.`
Method	matchAnySetting
Description	Matches systems with any setting.
Parameters	`boolean`	`match`	`true` to match systems with any setting, `false` to match systems with no settings
Compliance	`mandatory`		This method must be implemented.
Method	clearSettingTerms
Description	Clears the setting query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSceneId
Description	Sets the scene `Id` for this query.
Parameters	`osid.id.Id`	`sceneId`	the scene `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`sceneId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSceneIdTerms
Description	Clears the scene `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSceneQuery
Description	Tests if a `SceneQuery` is available.
Return	`boolean`		`true` if a scene query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSceneQuery
Description	Gets the query for a scene. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.SceneQuery`		the scene query
Errors	UNIMPLEMENTED		`supportsSceneQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSceneQuery()` is `true.`
Method	matchAnyScene
Description	Matches systems with any scene.
Parameters	`boolean`	`match`	`true` to match systems with any scene, `false` to match systems with no scenes
Compliance	`mandatory`		This method must be implemented.
Method	clearSceneTerms
Description	Clears the scene query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTriggerId
Description	Sets the trigger `Id` for this query.
Parameters	`osid.id.Id`	`triggerId`	the trigger `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`triggerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTriggerIdTerms
Description	Clears the trigger `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTriggerQuery
Description	Tests if a `TriggerQuery` is available.
Return	`boolean`		`true` if a trigger query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTriggerQuery
Description	Gets the query for a trigger. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.TriggerQuery`		the trigger query
Errors	UNIMPLEMENTED		`supportsTriggerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTriggerQuery()` is `true.`
Method	matchAnyTrigger
Description	Matches systems with any trigger.
Parameters	`boolean`	`match`	`true` to match systems with any trigger, `false` to match systems with no trigger
Compliance	`mandatory`		This method must be implemented.
Method	clearTriggerTerms
Description	Clears the trigger query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActionGroupId
Description	Sets the action group `Id` for this query.
Parameters	`osid.id.Id`	`actionGroupId`	the action group `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`actionGroupId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActionGroupIdTerms
Description	Clears the action group `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActionGroupQuery
Description	Tests if an `ActionGroup` is available.
Return	`boolean`		`true` if an action group query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActionGroupQuery
Description	Gets the query for an action group. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.ActionGroupQuery`		the action group query
Errors	UNIMPLEMENTED		`supportsActionGroupQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActionGroupQuery()` is `true.`
Method	matchAnyActionGroup
Description	Matches systems with any action group.
Parameters	`boolean`	`match`	`true` to match systems with any action group, `false` to match systems with no action groups
Compliance	`mandatory`		This method must be implemented.
Method	clearActionGroupTerms
Description	Clears the action group query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorSystemId
Description	Sets the system `Id` for this query to match systems that have the specified system as an ancestor.
Parameters	`osid.id.Id`	`systemId`	a system `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`systemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorSystemIdTerms
Description	Clears the ancestor system `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorSystemQuery
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	getAncestorSystemQuery
Description	Gets the query for a system. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.SystemQuery`		the system query
Errors	UNIMPLEMENTED		`supportsAncestorSystemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorSystemQuery()` is `true.`
Method	matchAnyAncestorSystem
Description	Matches systems with any ancestor.
Parameters	`boolean`	`match`	`true` to match systems with any ancestor, `false` to match root systems
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorSystemTerms
Description	Clears the ancestor system query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantSystemId
Description	Sets the system `Id` for this query to match systems that have the specified system as a descendant.
Parameters	`osid.id.Id`	`systemId`	a system `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`systemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantSystemIdTerms
Description	Clears the descendant system `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantSystemQuery
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	getDescendantSystemQuery
Description	Gets the query for a system/ Multiple retrievals produce a nested `OR` term.
Return	`osid.control.SystemQuery`		the system query
Errors	UNIMPLEMENTED		`supportsDescendantSystemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantSystemQuery()` is `true.`
Method	matchAnyDescendantSystem
Description	Matches systems with any descendant.
Parameters	`boolean`	`match`	`true` to match systems with any descendant, `false` to match leaf systems
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantSystemTerms
Description	Clears the descendant system query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getSystemQueryRecord
Description	Gets the system query record corresponding to the given `System` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`systemRecordType`	a system record type
Return	`osid.control.records.SystemQueryRecord`		the system query record
Errors	NULL_ARGUMENT		`systemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(systemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.