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

This session provides methods to re-assign Settings to System mappings. A Setting may appear in multiple System objects 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
CompliancemandatoryThis 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.IdsystemIdthe Id of the System
Returnboolean false if mapping 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 setting 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.
MethodgetAssignableSystemIdsForSetting
Description

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

Parametersosid.id.IdsystemIdthe Id of the System
osid.id.IdsettingIdthe Id of the Setting
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId or settingId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignSettingToSystem
Description

Adds an existing Setting to a System.

Parametersosid.id.IdsettingIdthe Id of the Setting
osid.id.IdsystemIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSettingFromSystem
Description

Removes a Setting from a System.

Parametersosid.id.IdsettingIdthe Id of the Setting
osid.id.IdsystemIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignSettingToSystem
Description

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

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