OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SceneQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching scenes. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

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 scenes with any setting.

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

Clears the setting query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSystemId
Description

Sets the system Id for this query to match scenes assigned to systems.

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

Clears the system Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSystemQuery
Description

Tests if a SystemQuery is available.

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

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

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

Clears the system query terms.

CompliancemandatoryThis method must be implemented.
MethodgetSceneQueryRecord
Description

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

Parametersosid.type.TypesceneRecordTypea scene record type
Returnosid.control.records.SceneQueryRecordthe scene query record
ErrorsNULL_ARGUMENT sceneRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(sceneRecordType) is false
CompliancemandatoryThis method must be implemented.