Interface | osid.control.rules.DeviceEnablerRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | getSystemId | ||
Description |
Gets the | ||
Return | osid.id.Id | the System Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystem | ||
Description |
Gets the | ||
Return | osid.control.System | the system | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupDeviceEnablerRules | ||
Description |
Tests if this user can perform lookups of device
enabler/device mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeDeviceEnablerRuleView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryDeviceEnablerRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedSystemView | ||
Description |
Federates the view for methods in this session. A federated view will include device enablers in systems which are children of this system in the system hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedSystemView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this system only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDeviceEnablerIdsForDevice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | deviceId | Id of the Device |
Return | osid.id.IdList | the device enabler Ids | |
Errors | NOT_FOUND | deviceId is not found | |
NULL_ARGUMENT | device is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceEnablersForDevice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | deviceId | Id of the Device |
Return | osid.control.rules.DeviceEnablerList | the device enablers | |
Errors | NOT_FOUND | deviceId is not found | |
NULL_ARGUMENT | deviceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceIdsForDeviceEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | deviceEnablerId | Id of a DeviceEnabler |
Return | osid.id.IdList | list of device Ids | |
Errors | NOT_FOUND | deviceEnablerId is not found | |
NULL_ARGUMENT | deviceEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDevicesForDeviceEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | deviceEnablerId | Id of a DeviceEnabler |
Return | osid.control.DeviceList | list of devices | |
Errors | NOT_FOUND | deviceEnablerId is not found | |
NULL_ARGUMENT | deviceEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |