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

This session provides methods to retrieve Setting to System settings. A Setting may appear in multiple System objects. Each system may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupSettingSystemSettings
Description

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

Returnboolean false if looking up settings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSettingSystemView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySettingSystemView
Description

A complete view of the Setting and System returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetSettingIdsBySystem
Description

Gets the list of Setting Ids associated with a System.

Parametersosid.id.IdsystemId Id of the System
Returnosid.id.IdListlist of related setting Ids
ErrorsNOT_FOUND systemId is not found
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSettingsBySystem
Description

Gets the list of Settings associated with a System.

Parametersosid.id.IdsystemId Id of the System
Returnosid.control.SettingListlist of related settings
ErrorsNOT_FOUND systemId is not found
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSettingIdsBySystems
Description

Gets the list of Setting Ids corresponding to a list of Systems.

Parametersosid.id.IdListsystemIdslist of system Ids
Returnosid.id.IdListlist of setting Ids
ErrorsNULL_ARGUMENT systemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSettingsBySystems
Description

Gets the list of Settings corresponding to a list of Systems.

Parametersosid.id.IdListsystemIdslist of system Ids
Returnosid.control.SettingListlist of settings
ErrorsNULL_ARGUMENT systemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSystemIdsBySetting
Description

Gets the System Ids mapped to a Setting.

Parametersosid.id.IdsettingId Id of a Setting
Returnosid.id.IdListlist of systems
ErrorsNOT_FOUND settingId is not found
NULL_ARGUMENT settingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSystemsBySetting
Description

Gets the Systems mapped to a Setting.

Parametersosid.id.IdsettingId Id of a Setting
Returnosid.control.SystemListlist of systems
ErrorsNOT_FOUND settingId is not found
NULL_ARGUMENT settingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.