org.osid.control

Interface DeviceSystemSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupDeviceSystemMappings

boolean canLookupDeviceSystemMappings()

Tests if this user can perform lookups of device/system 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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeDeviceSystemView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryDeviceSystemView

void usePlenaryDeviceSystemView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getDeviceIdsBySystem

IdList getDeviceIdsBySystem(Id systemId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets the list of Device Ids associated with a System.

Parameters:

systemId - Id of the System

Returns:

list of related device Ids

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDevicesBySystem

DeviceList getDevicesBySystem(Id systemId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the list of Devices associated with a System.

Parameters:

systemId - Id of the System

Returns:

list of related devices

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDeviceIdsBySystems

IdList getDeviceIdsBySystems(IdList systemIds)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets the list of Device Ids corresponding to a list of Systems.

Parameters:

systemIds - list of system Ids

Returns:

list of device Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDevicesBySystems

DeviceList getDevicesBySystems(IdList systemIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the list of Device corresponding to a list of Systems.

Parameters:

systemIds - list of system Ids

Returns:

list of devices

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemIdsByDevice

IdList getSystemIdsByDevice(Id deviceId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets the System Ids mapped to a Device.

Parameters:

deviceId - Id of a Device

Returns:

list of systems

Throws:

NotFoundException - deviceId is not found

NullArgumentException - deviceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemsByDevice

SystemList getSystemsByDevice(Id deviceId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the Systems mapped to a Device.

Parameters:

deviceId - Id of a Device

Returns:

list of systems

Throws:

NotFoundException - deviceId is not found

NullArgumentException - deviceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.