OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.InputSystemAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Inputs to System mappings. A Input may appear in multiple System objects and removing the last reference to a Input 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 Input to another System is not a copy operation (eg: does not change its Id ).

MethodcanAssignInputs
Description

Tests if this user can alter input/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 input assignment is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignInputsToSystem
Description

Tests if this user can alter input/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.IdsystemIdthe Id of the System
Returnboolean false if input assignment is not authorized, true otherwise
ErrorsNULL_ARGUMENT systemId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableSystemIds
Description

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

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableSystemIdsForInput
Description

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

Parametersosid.id.IdsystemIdthe Id of the System
osid.id.IdinputIdthe Id of the Input
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId or inputId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignInputToSystem
Description

Adds an existing Input to a System.

Parametersosid.id.IdinputIdthe Id of the Input
osid.id.IdsystemIdthe Id of the System
ErrorsALREADY_EXISTS inputId is already assigned to systemId
NOT_FOUND inputId or systemId not found
NULL_ARGUMENT inputId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignInputFromSystem
Description

Removes a Input from a System.

Parametersosid.id.IdinputIdthe Id of the Input
osid.id.IdsystemIdthe Id of the System
ErrorsNOT_FOUND inputId or systemId not found or inputId not assigned to systemId
NULL_ARGUMENT inputId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignInputToSystem
Description

Moves an Input from one System to another. Mappings to other Systems are unaffected.

Parametersosid.id.IdinputIdthe Id of the Input
osid.id.IdfromSystemIdthe Id of the current System
osid.id.IdtoSystemIdthe Id of the destination System
ErrorsNOT_FOUND inputId, fromSystemId, or toSystemId not found or inputId not mapped to fromSystemId
NULL_ARGUMENT inputId, fromSystemId, or toSystemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.