OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SystemQuery
Implementsosid.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.

MethodmatchDeviceId
Description

Sets the device Id for this query to match systems that have a related device.

Parametersosid.id.IddeviceIda device Id
booleanmatch true if a positive match, false for negative match
ErrorsNULL_ARGUMENT deviceId is null
CompliancemandatoryThis method must be implemented.
MethodclearDeviceIdTerms
Description

Clears the device Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceQuery
Description

Tests if a DeviceQuery is available.

Returnboolean true if a device query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDeviceQuery
Description

Gets the query for a device. Multiple retrievals produce a nested OR term.

Returnosid.control.DeviceQuerythe device query
ErrorsUNIMPLEMENTED supportsDeviceQuery() is false
ComplianceoptionalThis method must be implemented if supportsDeviceQuery() is true.
MethodmatchAnyDevice
Description

Matches systems that have any device.

Parametersbooleanmatch true to match systems with any device, false to match systems with no device
CompliancemandatoryThis method must be implemented.
MethodclearDeviceTerms
Description

Clears the device query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchControllerId
Description

Sets the controller Id for this query.

Parametersosid.id.IdcontrollerIdthe controller Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT controllerId is null
CompliancemandatoryThis method must be implemented.
MethodclearControllerIdTerms
Description

Clears the controller Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsControllerQuery
Description

Tests if a ControllerQuery is available.

Returnboolean true if a controller query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetControllerQuery
Description

Gets the query for a controller. Multiple retrievals produce a nested OR term.

Returnosid.control.ControllerQuerythe controller query
ErrorsUNIMPLEMENTED supportsControllerQuery() is false
ComplianceoptionalThis method must be implemented if supportsControllerQuery() is true.
MethodmatchAnyController
Description

Matches systems with any controller.

Parametersbooleanmatch true to match systems with any controller, false to match systems with no controller
CompliancemandatoryThis method must be implemented.
MethodclearControllerTerms
Description

Clears the controller query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInputId
Description

Sets the input Id for this query.

Parametersosid.id.IdinputIdthe input Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT inputId is null
CompliancemandatoryThis method must be implemented.
MethodclearInputIdTerms
Description

Clears the input Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsInputQuery
Description

Tests if an InputQuery is available.

Returnboolean true if an input query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInputQuery
Description

Gets the query for an input. Multiple retrievals produce a nested OR term.

Returnosid.control.InputQuerythe input query
ErrorsUNIMPLEMENTED supportsInputQuery() is false
ComplianceoptionalThis method must be implemented if supportsInputQuery() is true.
MethodmatchAnyInput
Description

Matches systems with any input.

Parametersbooleanmatch true to match systems with any input, false to match systems with no inputs
CompliancemandatoryThis method must be implemented.
MethodclearInputTerms
Description

Clears the input query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSettingId
Description

Sets the setting Id for this query.

Parametersosid.id.IdsettingIdthe setting Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT settingId is null
CompliancemandatoryThis method must be implemented.
MethodclearSettingIdTerms
Description

Clears the setting Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSettingQuery
Description

Tests if a SettingQuery is available.

Returnboolean true if a setting query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSettingQuery
Description

Gets the query for a setting. Multiple retrievals produce a nested OR term.

Returnosid.control.SettingQuerythe setting query
ErrorsUNIMPLEMENTED supportsSettingQuery() is false
ComplianceoptionalThis method must be implemented if supportsSettingQuery() is true.
MethodmatchAnySetting
Description

Matches systems with any setting.

Parametersbooleanmatch true to match systems with any setting, false to match systems with no settings
CompliancemandatoryThis method must be implemented.
MethodclearSettingTerms
Description

Clears the setting query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSceneId
Description

Sets the scene Id for this query.

Parametersosid.id.IdsceneIdthe scene Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT sceneId is null
CompliancemandatoryThis method must be implemented.
MethodclearSceneIdTerms
Description

Clears the scene Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSceneQuery
Description

Tests if a SceneQuery is available.

Returnboolean true if a scene query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSceneQuery
Description

Gets the query for a scene. Multiple retrievals produce a nested OR term.

Returnosid.control.SceneQuerythe scene query
ErrorsUNIMPLEMENTED supportsSceneQuery() is false
ComplianceoptionalThis method must be implemented if supportsSceneQuery() is true.
MethodmatchAnyScene
Description

Matches systems with any scene.

Parametersbooleanmatch true to match systems with any scene, false to match systems with no scenes
CompliancemandatoryThis method must be implemented.
MethodclearSceneTerms
Description

Clears the scene query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTriggerId
Description

Sets the trigger Id for this query.

Parametersosid.id.IdtriggerIdthe trigger Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT triggerId is null
CompliancemandatoryThis method must be implemented.
MethodclearTriggerIdTerms
Description

Clears the trigger Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerQuery
Description

Tests if a TriggerQuery is available.

Returnboolean true if a trigger query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTriggerQuery
Description

Gets the query for a trigger. Multiple retrievals produce a nested OR term.

Returnosid.control.TriggerQuerythe trigger query
ErrorsUNIMPLEMENTED supportsTriggerQuery() is false
ComplianceoptionalThis method must be implemented if supportsTriggerQuery() is true.
MethodmatchAnyTrigger
Description

Matches systems with any trigger.

Parametersbooleanmatch true to match systems with any trigger, false to match systems with no trigger
CompliancemandatoryThis method must be implemented.
MethodclearTriggerTerms
Description

Clears the trigger query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActionGroupId
Description

Sets the action group Id for this query.

Parametersosid.id.IdactionGroupIdthe action group Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT actionGroupId is null
CompliancemandatoryThis method must be implemented.
MethodclearActionGroupIdTerms
Description

Clears the action group Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupQuery
Description

Tests if an ActionGroup is available.

Returnboolean true if an action group query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupQuery
Description

Gets the query for an action group. Multiple retrievals produce a nested OR term.

Returnosid.control.ActionGroupQuerythe action group query
ErrorsUNIMPLEMENTED supportsActionGroupQuery() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupQuery() is true.
MethodmatchAnyActionGroup
Description

Matches systems with any action group.

Parametersbooleanmatch true to match systems with any action group, false to match systems with no action groups
CompliancemandatoryThis method must be implemented.
MethodclearActionGroupTerms
Description

Clears the action group query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorSystemId
Description

Sets the system Id for this query to match systems that have the specified system as an ancestor.

Parametersosid.id.IdsystemIda system Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT systemId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorSystemIdTerms
Description

Clears the ancestor system Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorSystemQuery
Description

Tests if a SystemQuery is available.

Returnboolean true if a system query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorSystemQuery
Description

Gets the query for a system. Multiple retrievals produce a nested OR term.

Returnosid.control.SystemQuerythe system query
ErrorsUNIMPLEMENTED supportsAncestorSystemQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorSystemQuery() is true.
MethodmatchAnyAncestorSystem
Description

Matches systems with any ancestor.

Parametersbooleanmatch true to match systems with any ancestor, false to match root systems
CompliancemandatoryThis method must be implemented.
MethodclearAncestorSystemTerms
Description

Clears the ancestor system query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantSystemId
Description

Sets the system Id for this query to match systems that have the specified system as a descendant.

Parametersosid.id.IdsystemIda system Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT systemId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantSystemIdTerms
Description

Clears the descendant system Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantSystemQuery
Description

Tests if a SystemQuery is available.

Returnboolean true if a system query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantSystemQuery
Description

Gets the query for a system/ Multiple retrievals produce a nested OR term.

Returnosid.control.SystemQuerythe system query
ErrorsUNIMPLEMENTED supportsDescendantSystemQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantSystemQuery() is true.
MethodmatchAnyDescendantSystem
Description

Matches systems with any descendant.

Parametersbooleanmatch true to match systems with any descendant, false to match leaf systems
CompliancemandatoryThis method must be implemented.
MethodclearDescendantSystemTerms
Description

Clears the descendant system query terms.

CompliancemandatoryThis method must be implemented.
MethodgetSystemQueryRecord
Description

Gets the system query record corresponding to the given System record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypesystemRecordTypea system record type
Returnosid.control.records.SystemQueryRecordthe system query record
ErrorsNULL_ARGUMENT systemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(systemRecordType) is false
CompliancemandatoryThis method must be implemented.