public interface DeviceEnablerSystemSession extends OsidSession
This session provides methods to retrieve DeviceEnabler
to System
mappings. A DeviceEnabler
may
appear in multiple System
objects. Each system may have its
own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupDeviceEnablerSystemMappings()
Tests if this user can perform lookups of device enabler/system
mappings.
|
IdList |
getDeviceEnablerIdsBySystem(Id systemId)
Gets the list of
DeviceEnablerIds associated with a
System. |
IdList |
getDeviceEnablerIdsBySystems(IdList systemIds)
Gets the list of
DeviceEnabler Ids corresponding to a
list of Systems. |
DeviceEnablerList |
getDeviceEnablersBySystem(Id systemId)
Gets the list of device enablers associated with a
System. |
DeviceEnablerList |
getDeviceEnablersBySystems(IdList systemIds)
Gets the list of device enablers corresponding to a list of
Systems. |
IdList |
getSystemIdsByDeviceEnabler(Id deviceEnablerId)
Gets the
System Ids mapped to a
DeviceEnabler. |
SystemList |
getSystemsByDeviceEnabler(Id deviceEnablerId)
Gets the
Systems mapped to a DeviceEnabler. |
void |
useComparativeDeviceEnablerSystemView()
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 |
usePlenaryDeviceEnablerSystemView()
A complete view of the
DeviceEnabler and System
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupDeviceEnablerSystemMappings()
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 useComparativeDeviceEnablerSystemView()
mandatory
- This method is must be implemented. void usePlenaryDeviceEnablerSystemView()
DeviceEnabler
and System
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. IdList getDeviceEnablerIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
DeviceEnablerIds
associated with a
System.
systemId
- Id
of the System
Ids
NotFoundException
- systemId
is not
foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeviceEnablerList getDeviceEnablersBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System.
systemId
- Id
of the System
NotFoundException
- systemId
is not
foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDeviceEnablerIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
DeviceEnabler Ids
corresponding to a
list of Systems.
systemIds
- list of system Ids
Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeviceEnablerList getDeviceEnablersBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Systems.
systemIds
- list of system Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSystemIdsByDeviceEnabler(Id deviceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
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. SystemList getSystemsByDeviceEnabler(Id deviceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
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.