OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.DeviceEnablerRuleLookupSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve DeviceEnabler to Device mappings. A Device with multiple DeviceEnablers means any positive rule evaluation across the enablers result in an effective Device.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated system view: All methods in this session operate, retrieve and pertain device enablers defined explicitly in the current system.
  • federated system view: All methods in this session operate, retrieve and pertain to all device enablers defined in this system and any other device enablers implicitly available in this system through system inheritence.
MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupDeviceEnablerRules
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeDeviceEnablerRuleView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryDeviceEnablerRuleView
Description

A complete view of the DeviceEnabler and Device returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedSystemView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedSystemView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this system only.

CompliancemandatoryThis method is must be implemented.
MethodgetDeviceEnablerIdsForDevice
Description

Gets the DeviceEnabler Id associated with a Device.

Parametersosid.id.IddeviceId Id of the Device
Returnosid.id.IdListthe device enabler Ids
ErrorsNOT_FOUND deviceId is not found
NULL_ARGUMENT device is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDeviceEnablersForDevice
Description

Gets the DeviceEnablers associated with a Device.

Parametersosid.id.IddeviceId Id of the Device
Returnosid.control.rules.DeviceEnablerListthe device enablers
ErrorsNOT_FOUND deviceId is not found
NULL_ARGUMENT deviceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDeviceIdsForDeviceEnabler
Description

Gets the Device Ids mapped to a DeviceEnabler.

Parametersosid.id.IddeviceEnablerId Id of a DeviceEnabler
Returnosid.id.IdListlist of device Ids
ErrorsNOT_FOUND deviceEnablerId is not found
NULL_ARGUMENT deviceEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDevicesForDeviceEnabler
Description

Gets the Devices mapped to a DeviceEnabler.

Parametersosid.id.IddeviceEnablerId Id of a DeviceEnabler
Returnosid.control.DeviceListlist of devices
ErrorsNOT_FOUND deviceEnablerId is not found
NULL_ARGUMENT deviceEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.