org.osid.control

Interface DeviceSystemAssignmentSession

All Superinterfaces:

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

public interface DeviceSystemAssignmentSession
extends OsidSession

This session provides methods to re-assign Devices to System mappings. A Device may appear in multiple System objects and removing the last reference to a Device is the equivalent of deleting it. Each System may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Device to another System is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignDeviceToSystem(Id deviceId, Id systemId) Adds an existing Device to a System.
boolean	canAssignDevices() Tests if this user can alter device/system mappings.
boolean	canAssignDevicesToSystem(Id systemId) Tests if this user can alter device/system mappings.
IdList	getAssignableSystemIds(Id systemId) Gets a list of systems including and under the given system node in which any device can be assigned.
IdList	getAssignableSystemIdsForDevice(Id systemId, Id deviceId) Gets a list of systems including and under the given system node in which a specific device can be assigned.
void	reassignDeviceToSystem(Id deviceId, Id fromSystemId, Id toSystemId) Moves a Device from one System to another.
void	unassignDeviceFromSystem(Id deviceId, Id systemId) Removes a Device from a System.

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

canAssignDevices

boolean canAssignDevices()

Tests if this user can alter device/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returns:

false if control is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignDevicesToSystem

boolean canAssignDevicesToSystem(Id systemId)

Tests if this user can alter device/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parameters:

systemId - the Id of the System

Returns:

false if control is not authorized, true otherwise

Throws:

NullArgumentException - systemId is null

Compliance:

mandatory - This method must be implemented.

getAssignableSystemIds

IdList getAssignableSystemIds(Id systemId)
                              throws OperationFailedException

Gets a list of systems including and under the given system node in which any device can be assigned.

Parameters:

systemId - the Id of the System

Returns:

list of assignable system Ids

Throws:

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableSystemIdsForDevice

IdList getAssignableSystemIdsForDevice(Id systemId,
                                     Id deviceId)
                                       throws OperationFailedException

Gets a list of systems including and under the given system node in which a specific device can be assigned.

Parameters:

systemId - the Id of the System

deviceId - the Id of the Device

Returns:

list of assignable system Ids

Throws:

NullArgumentException - systemId or deviceId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignDeviceToSystem

void assignDeviceToSystem(Id deviceId,
                        Id systemId)
                          throws AlreadyExistsException,
                                 NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Adds an existing Device to a System.

Parameters:

deviceId - the Id of the Device

systemId - the Id of the System

Throws:

AlreadyExistsException - deviceId is slready assigned to systemId

NotFoundException - deviceId or systemId not found

NullArgumentException - deviceId or systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDeviceFromSystem

void unassignDeviceFromSystem(Id deviceId,
                            Id systemId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Removes a Device from a System.

Parameters:

deviceId - the Id of the Device

systemId - the Id of the System

Throws:

NotFoundException - deviceId or systemId not found or deviceId not assigned to systemId

NullArgumentException - deviceId or systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignDeviceToSystem

void reassignDeviceToSystem(Id deviceId,
                          Id fromSystemId,
                          Id toSystemId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Moves a Device from one System to another. Mappings to other Systems are unaffected.

Parameters:

deviceId - the Id of the Device

fromSystemId - the Id of the current System

toSystemId - the Id of the destination System

Throws:

NotFoundException - deviceId, fromSystemId, or toSystemId not found or deviceId not mapped to fromSystemId

NullArgumentException - deviceId, fromSystemId, or toSystemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.