Interface | osid.control.ControllerSystemSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupControllerSystemMappings | ||
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 | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeControllerSystemView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryControllerSystemView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getControllerIdsBySystem | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | systemId | Id of the System |
Return | osid.id.IdList | list of related controller Ids | |
Errors | NOT_FOUND | systemId is not found | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getControllersBySystem | ||
Description |
Gets the list of controllers associated with a | ||
Parameters | osid.id.Id | systemId | Id of the System |
Return | osid.control.ControllerList | list of related controllers | |
Errors | NOT_FOUND | systemId is not found | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getControllerIdsBySystems | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | systemIds | list of system Ids |
Return | osid.id.IdList | list of controller Ids | |
Errors | NULL_ARGUMENT | systemIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getControllersBySystems | ||
Description |
Gets the list of controllers corresponding to a list of
| ||
Parameters | osid.id.IdList | systemIds | list of system Ids |
Return | osid.control.ControllerList | list of controllers | |
Errors | NULL_ARGUMENT | systemIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSystemIdsByController | ||
Description |
Gets the | ||
Parameters | osid.id.Id | controllerId | Id of a Controller |
Return | osid.id.IdList | list of systems | |
Errors | NOT_FOUND | controllerId is not found | |
NULL_ARGUMENT | controllerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSystemsByController | ||
Description |
Gets the | ||
Parameters | osid.id.Id | controllerId | Id of a Controller |
Return | osid.control.SystemList | list of systems | |
Errors | NOT_FOUND | controllerId is not found | |
NULL_ARGUMENT | controllerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |