public interface DeviceSystemSession extends OsidSession
This session provides methods to retrieve Device
to
System
mappings. A Device
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 |
canLookupDeviceSystemMappings()
Tests if this user can perform lookups of device/system mappings.
|
IdList |
getDeviceIdsBySystem(Id systemId)
Gets the list of
Device Ids associated with a
System. |
IdList |
getDeviceIdsBySystems(IdList systemIds)
Gets the list of
Device Ids corresponding to a list of
Systems. |
DeviceList |
getDevicesBySystem(Id systemId)
Gets the list of
Devices associated with a
System. |
DeviceList |
getDevicesBySystems(IdList systemIds)
Gets the list of
Device corresponding to a list of
Systems. |
IdList |
getSystemIdsByDevice(Id deviceId)
Gets the
System Ids mapped to a
Device. |
SystemList |
getSystemsByDevice(Id deviceId)
Gets the
Systems mapped to a Device. |
void |
useComparativeDeviceSystemView()
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 |
usePlenaryDeviceSystemView()
A complete view of the
Device and System
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupDeviceSystemMappings()
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 useComparativeDeviceSystemView()
mandatory
- This method is must be implemented. void usePlenaryDeviceSystemView()
Device
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 getDeviceIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Device Ids
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. DeviceList getDevicesBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Devices
associated with a
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 getDeviceIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Device 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. DeviceList getDevicesBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Device
corresponding to a list of
Systems.
systemIds
- list of system Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSystemIdsByDevice(Id deviceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
Ids
mapped to a
Device.
deviceId
- Id
of a Device
NotFoundException
- deviceId
is not
foundNullArgumentException
- deviceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByDevice(Id deviceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
mapped to a Device.
deviceId
- Id
of a Device
NotFoundException
- deviceId
is not
foundNullArgumentException
- deviceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.