Interface | osid.control.rules.DeviceEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching device enablers. Each
method match specifies an | ||
Method | matchRuledTriggerId | ||
Description |
Matches enablers mapped to the trigger. | ||
Parameters | osid.id.Id | triggerId | the trigger Id |
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 | clearRuledTriggerIdTerms | ||
Description |
Clears the trigger | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledTriggerQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an trigger query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledTriggerQuery | ||
Description |
Gets the query for an trigger. Multiple retrievals
produce a nested | ||
Return | osid.control.TriggerQuery | the trigger query | |
Errors | UNIMPLEMENTED | supportsRuledTriggerQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledTriggerQuery()
is true. | |
Method | matchAnyRuledTrigger | ||
Description |
Matches enablers mapped to any trigger. | ||
Parameters | boolean | match | true for enablers mapped to any trigger, false
to match enablers mapped to no triggers |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledTriggerTerms | ||
Description |
Clears the trigger 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 |
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 | ||
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 | getDeviceEnablerQueryRecord | ||
Description |
Gets the device enabler query record corresponding to
the given | ||
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. |