OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.DeviceSystemAssignmentSession
Implementsosid.OsidSession
Used Byosid.control.ControlManager
osid.control.ControlProxyManager
Description

This session provides methods to re-assign Devices to System mappings. A Device may appear in multiple Systems 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).

MethodcanAssignDevices
Description

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.

Returnboolean false if control is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignDevicesToSystem
Description

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.

Parametersosid.id.IdsystemId the Id of the System
Returnboolean false if control is not authorized, true otherwise
ErrorsNULL_ARGUMENT systemId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableSystemIds
Description

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

Parametersosid.id.IdsystemId the Id of the System
Returnosid.id.IdList list of assignable system Ids
ErrorsNULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableSystemIdsForDevice
Description

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

Parametersosid.id.IdsystemId the Id of the System
osid.id.IddeviceId the Id of the Device
Returnosid.id.IdList list of assignable system Ids
ErrorsNULL_ARGUMENT systemId or deviceId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignDeviceToSystem
Description

Adds an existing Device to a System.

Parametersosid.id.IddeviceId the Id of the Device
osid.id.IdsystemId the Id of the System
ErrorsALREADY_EXISTS deviceId is slready assigned to systemId
NOT_FOUND deviceId or systemId not found
NULL_ARGUMENT deviceId or systemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignDeviceFromSystem
Description

Removes a Device from a System.

Parametersosid.id.IddeviceId the Id of the Device
osid.id.IdsystemId the Id of the System
ErrorsNOT_FOUND deviceId or systemId not found or deviceId not assigned to systemId
NULL_ARGUMENT deviceId or systemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignDeviceToSystem
Description

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

Parametersosid.id.IddeviceId the Id of the Device
osid.id.IdfromSystemId the Id of the current System
osid.id.IdtoSystemId the Id of the destination System
ErrorsALREADY_EXISTS deviceId already assigned to toSystemId
NOT_FOUND deviceId, fromSystemId, or toSystemId not found or deviceId not mapped to fromSystemId
NULL_ARGUMENT deviceId, fromSystemId, or toSystemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.