public interface DeviceEnablerRuleLookupSession extends OsidSession
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupDeviceEnablerRules()
Tests if this user can perform lookups of device enabler/device
mappings.
|
IdList |
getDeviceEnablerIdsForDevice(Id deviceId)
Gets the
DeviceEnabler Id associated with a
Device. |
DeviceEnablerList |
getDeviceEnablersForDevice(Id deviceId)
Gets the
DeviceEnablers associated with a
Device. |
IdList |
getDeviceIdsForDeviceEnabler(Id deviceEnablerId)
Gets the
Device Ids mapped to a
DeviceEnabler. |
DeviceList |
getDevicesForDeviceEnabler(Id deviceEnablerId)
Gets the
Devices mapped to a DeviceEnabler. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useComparativeDeviceEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenaryDeviceEnablerRuleView()
A complete view of the
DeviceEnabler and Device
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupDeviceEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeDeviceEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryDeviceEnablerRuleView()
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.mandatory
- This method is must be implemented. void useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. IdList getDeviceEnablerIdsForDevice(Id deviceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
DeviceEnabler Id
associated with a
Device.
deviceId
- Id
of the Device
Ids
NotFoundException
- deviceId
is not
foundNullArgumentException
- device
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeviceEnablerList getDeviceEnablersForDevice(Id deviceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
DeviceEnablers
associated with a
Device.
deviceId
- Id
of the Device
NotFoundException
- deviceId
is not
foundNullArgumentException
- deviceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDeviceIdsForDeviceEnabler(Id deviceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Device
Ids
mapped to a
DeviceEnabler.
deviceEnablerId
- Id
of a DeviceEnabler
Ids
NotFoundException
- deviceEnablerId
is
not foundNullArgumentException
- deviceEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeviceList getDevicesForDeviceEnabler(Id deviceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Devices
mapped to a DeviceEnabler.
deviceEnablerId
- Id
of a DeviceEnabler
NotFoundException
- deviceEnablerId
is
not foundNullArgumentException
- deviceEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.