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

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

MethodcanAssignSettings
Description

Tests if this user can alter setting/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 setting is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignSettingsToSystem
Description

Tests if this user can alter setting/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 mapping 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 setting 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.
MethodgetAssignableSystemIdsForSetting
Description

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

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

Adds an existing Setting to a System.

Parametersosid.id.IdsettingId the Id of the Setting
osid.id.IdsystemId the Id of the System
ErrorsALREADY_EXISTS settingId is already assigned to systemId
NOT_FOUND settingId or systemId not found
NULL_ARGUMENT settingId or systemId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignSettingFromSystem
Description

Removes a Setting from a System.

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

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

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