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

This session provides methods to retrieve Controller to System mappings. A Controller 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
MethodcanLookupControllerSystemMappings
Description

Tests if this user can perform lookups of controller/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 mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeControllerSystemView
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.
MethodusePlenaryControllerSystemView
Description

A complete view of the Controller 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.
MethodgetControllerIdsBySystem
Description

Gets the list of Controller Ids associated with a System.

Parametersosid.id.IdsystemId Id of the System
Returnosid.id.IdListlist of related controller 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.
MethodgetControllersBySystem
Description

Gets the list of controllers associated with a System.

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

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

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

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

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

Gets the System Ids mapped to a Controller.

Parametersosid.id.IdcontrollerId Id of a Controller
Returnosid.id.IdListlist of systems
ErrorsNOT_FOUND controllerId is not found
NULL_ARGUMENT controllerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSystemsByController
Description

Gets the Systems mapped to a Controller.

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