Interface | osid.control.SceneQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching scenes. Each method match
specifies an | ||
Method | matchSettingId | ||
Description |
Sets the setting | ||
Parameters | osid.id.Id | settingId | the setting Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingQuery | ||
Description |
Tests if a | ||
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 | ||
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 scenes with any setting. | ||
Parameters | boolean | match | true to match scenes with any setting, false
to match scenes 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 | matchSystemId | ||
Description |
Sets the system | ||
Parameters | osid.id.Id | systemId | the scene Id |
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 | clearSystemIdTerms | ||
Description |
Clears the system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemQuery | ||
Description |
Tests if a | ||
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 | ||
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 | getSceneQueryRecord | ||
Description |
Gets the query record corresponding to the given | ||
Parameters | osid.type.Type | sceneRecordType | a scene record type |
Return | osid.control.records.SceneQueryRecord | the scene query record | |
Errors | NULL_ARGUMENT | sceneRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(sceneRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |